{"openapi":"3.0.2","info":{"version":"1.0.0","title":"Commerce Cloud REST API"},"externalDocs":{"description":"Introduction to the API, basic concepts, and tutorials","url":"https://developer.atlassian.com/platform/commerce/rest"},"x-atlassian-narrative":{"documents":[{"title":"About","anchor":"about","body":"This is the reference for the Commerce Cloud Platform REST API. This API is the primary way to get and modify data in Commerce, whether you are developing an app or any other integration. Use it to interact with Commerce entities, like orders, quotes, offerings, and pricing plans."},{"title":"Authentication","anchor":"authentication","body":"The Commerce API requires a token for authentication. Make sure to include your generated access token as an authorization header in all requests.\n\n``` bash\ncurl --request GET \\\n--url \"https://api.atlassian.com/commerce/api...\" \\\n--header \"Authorization: Bearer ACCESS_TOKEN\"\n```"},{"title":"Pagination","anchor":"pagination","body":"The Commerce API uses cursor-based pagination to limit response size for resources that may return large numbers of results. \nHTTP clients may specify a smaller page size of `N` by adding the query parameter `page-size=N`. The supported query parameters for pagination are: \n\nThe response for paginated endpoints will contain the following fragment:\n```\n{\n \"values\" :[\n // resource object\n ],\n \"nextId\": \n}\n```\nThe `nextId` attribute in the response payload should be used as the `start-id` query parameter to load entries from the next page of results."},{"title":"Dates","anchor":"dates","body":"All dates returned by the API are Unix timestamps."},{"title":"Monetary amounts","anchor":"monetary-amounts","body":"On Product and Quote APIs the currency values are accepted, and returned, in the lowest denominator. For example, for USD all values are returned in cents, for `$1.00` the returned value is `100`. For the rest of Commerce APIs the returned values are in dollar amount. Commerce will be looking at standardizing this in the future."},{"title":"Errors","anchor":"errors","body":"The following response status codes may be accompanied by an error representation.\n\n| Status | Description |\n|--------|----------------------------------------------------------------------|\n| 400 | Request body is malformed or has an illegal property value. |\n| 401 | Authentication is required. |\n| 403 | User was authenticated but is not authorized for this operation. |\n| 404 | Resource does not exist or is not visible to this user. |\n| 422 | The request body contains semantic errors. |\n| 429 | The client has exceeded the rate limit. |\n| 500 | Unexpected internal error in Commerce. |\n| 502 | Unexpected error in an external service. |\n\nError responses will contain a JSON representation like in the example below:\n\n``` javascript\n{\n \"title\": \"Invalid parameter: trial\",\n \"code\": \"parameter_invalid\",\n \"detail\": \"Invalid value :123123\",\n \"id\": \"uuid\",\n \"status\": \"400\"\n}\n```"}]},"servers":[{"url":"https://api.atlassian.com/commerce/api"}],"tags":[{"name":"Products","description":"A _product_ is a container for all catalog definitions of a product that Atlassian is making available to the market."},{"name":"Offerings","description":"An _offering_ represents a packaging of a product that'll result in an entitlement."},{"name":"PricingPlans","description":"_Pricing plans_ define how paid offerings are priced and charged for, and result in subscriptions."},{"name":"Invoices","description":"An _invoice_ is an itemized statement of amounts owed by a customer as a result of using one or more products."},{"name":"InvoiceGroups","description":"An _invoice group_ is a container that allows you to manage invoices."},{"name":"Orders","description":"An _order_ is an entity representing a user's intent to create, amend, or delete a contract to provide the enumerated service from a billing perspective."},{"name":"Quotes","description":"A _quote_ is a legally non-binding offer of products or services typically sent to a customer for consideration before making a buying decision."},{"name":"Entitlements","description":"An _entitlement_ is an instantiated offering from the product catalog."}],"paths":{"/v2/invoices":{"get":{"tags":["Invoices"],"description":"If the query param statusFilter is not present, all invoice are listed.\nIf statusFilter=PAID (case-sensitive), only paid invoice (instant or deferred) are included.\nIf statusFilter=UNPAID (case-sensitive), only unpaid invoices (that are finalised) are included.\n\nRate limit: 3000 requests per minute.","operationId":"getInvoices_1","parameters":[{"name":"X-transaction-account","in":"header","description":"Transaction Account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"invoice-group","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"status-filter","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"PAID Includes invoices with status PAID or DEFERRED_PAID, UNPAID Includes invoices with status OPEN or UNCOLLECTIBLE.","enum":["PAID","UNPAID"]}},{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedListV2InvoicePublicDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"ASAP":[]}],"x-target-latency":"4000","summary":"List invoices"}},"/v2/invoices/{id}":{"get":{"tags":["Invoices"],"description":"Retrieve the invoice by id.\n\nIn countries like Canada, Government collects taxes at national and state level.\nTo show these different taxes, we have taxItems.\nSo Tax calculation will have multiple taxes to be considered.\n\nTax summaries can be constructed by grouping on the taxAmountLabel property.\n\ne.g. multiple tax items - Canada.\n```\n//InvoiceItem (“item1”)\n {\n // other invoice item properties...\n\n taxItems: [\n {\n id: “taxItem1\",\n tax: 5.00,\n taxPercent: 10.00,\n taxId: null,\n taxAmountLabel: “GST”\n },\n {\n id: “taxItem2\",\n tax: 10.00,\n taxPercent: 20.00,\n taxId: “bc_tax_id_456”,\n taxAmountLabel: “HST”\n }\n ]\n },\n\n//InvoiceItem (“item2”)\n {\n // other invoice item properties...\n\n taxItems: [\n {\n id: “taxItem1\",\n tax: 3.00,\n taxPercent: 10.00,\n taxId: null,\n taxAmountLabel: “GST”\n },\n {\n id: “taxItem2\",\n tax: 6.00,\n taxPercent: 20.00,\n taxId: “bc_tax_id_456”,\n taxAmountLabel: “HST”\n }\n ]\n }\n```\nConsumers themselves will need to calculate TaxSummary as below.\n\n```\n{\n taxSummary[\n {\n id: “taxItem1”,\n tax: 8.00, // summed GST of both invoice items\n taxPercent: 10.00,\n taxId: null,\n taxAmountLabel: “GST”\n },\n {\n id: “taxItem2”,\n tax: 16.00, // summed HST of both invoice items\n taxPercent: 20.00,\n taxId: “bc_tax_id_456\",\n taxAmountLabel: “HST”\n }\n ]\n }\n```\n\n\nRate limit: 3000 requests per minute.","operationId":"getInvoice_1","parameters":[{"name":"X-transaction-account","in":"header","description":"Transaction Account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoicePublicDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"ASAP":[]}],"x-target-latency":"1500","summary":"Get invoice by ID"}},"/v2/invoice-groups/{id}":{"get":{"tags":["InvoiceGroups"],"description":"Retrieve invoice group by id\n\nRate limit: 3000 requests per minute.","operationId":"getInvoiceGroup_1","parameters":[{"name":"X-transaction-account","in":"header","description":"Transaction Account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceGroupPublicDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"ASAP":[]}],"summary":"Get invoice group by ID"}},"/v2/orders/{id}":{"get":{"tags":["Orders"],"summary":"Get order by ID","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-transaction-account","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGetResponseDtoV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/orders/{orderId}/orderItem/{orderItemId}":{"get":{"tags":["Orders"],"summary":"Get order item by ID","parameters":[{"name":"orderId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"orderItemId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-transaction-account","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGetResponseDtoV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/entitlements/{entitlementId}/details":{"get":{"tags":["Entitlements"],"summary":"Get entitlement details by ID","operationId":"getEntitlementsV2","parameters":[{"name":"entitlementId","in":"path","description":"Entitlement ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Fetching Entitlement Details with Limited Fields","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementDetailsV2"}}}},"400":{"description":"Invalid id supplied","content":{}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"404":{"description":"Entitlement not found","content":{}},"412":{"description":"Precondition Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}}},"description":"Rate limit: 3000 requests per minute."}},"/v2/products":{"get":{"tags":["Products"],"description":"List all products\n\nRate limit: 600 requests per minute.","parameters":[{"name":"status","in":"query","description":"Product status(DRAFT, ACTIVE, AT_NOTICE, EXPIRED)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ACTIVE","enum":["NONE","DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]}},{"name":"page-size","in":"query","description":"Pagination size","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","description":"Pagination offset cursor","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponsePublicProductResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"List products"}},"/v2/products/{id}":{"get":{"tags":["Products"],"parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicProductResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get product by ID","description":"Rate limit: 900 requests per minute."}},"/v3/offerings/{id}":{"get":{"tags":["Offerings"],"parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicOfferingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get offering by ID","description":"Rate limit: 900 requests per minute."}},"/v2/pricing-plans/{id}":{"get":{"tags":["PricingPlans"],"parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPricingPlanResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get pricing plan by ID","description":"Rate limit: 900 requests per minute."}},"/v1/offerings/{id}/related/{type}":{"get":{"tags":["Offerings"],"parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"type","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string","enum":["APP_DEPENDENCE","ADDON_DEPENDENCE","APP_COMPATIBILITY","FAMILY_CONTAINER","SANDBOX_DEPENDENCE","SANDBOX_GRANT","ENTERPRISE","MULTI_INSTANCE","ENTERPRISE_SANDBOX_GRANT","COLLECTION","COLLECTION_TRIAL"]}},{"name":"page-size","in":"query","description":"Pagination size","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","description":"Pagination offset cursor","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponsePublicOfferingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get related offerings","description":"Rate limit: 600 requests per minute."}},"/v2/products/{productId}/offerings":{"get":{"tags":["Offerings"],"description":"List all offerings under the provided product key\n\nRate limit: 600 requests per minute.","parameters":[{"name":"productId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"offering status(DRAFT, ACTIVE, AT_NOTICE, EXPIRED)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ACTIVE","enum":["NONE","DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]}},{"name":"creation-type","in":"query","description":"offering creation-type(DEFAULT_OFFERING, SYNTHETIC_OFFERING)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"DEFAULT_OFFERING","enum":["DEFAULT_OFFERING","SYNTHETIC_OFFERING"]}},{"name":"page-size","in":"query","description":"Pagination size","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"hosting-type","in":"query","description":"hosting type(CLOUD, DATACENTER, SERVER)","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CLOUD","DATACENTER","SERVER"]}},{"name":"start-id","in":"query","description":"Pagination offset cursor","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponsePublicOfferingResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get offerings by product"}},"/v2/offerings/{offeringId}/pricing-plans":{"get":{"tags":["PricingPlans"],"description":"List all pricing plans under the provided offering key\n\nRate limit: 600 requests per minute.","parameters":[{"name":"offeringId","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"pricing plans status(ACTIVE, AT_NOTICE, EXPIRED)","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"ACTIVE","enum":["NONE","ACTIVE","AT_NOTICE","EXPIRED"]}},{"name":"activation-reason-code","in":"query","description":"pricing plan activation-reason-code(DEFAULT_PRICING, ADVANTAGE_PRICING, EXPERIMENTAL_PRICING)","required":false,"style":"form","explode":true,"schema":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["DEFAULT_PRICING","ADVANTAGE_PRICING","EXPERIMENTAL_PRICING"]},"default":["DEFAULT_PRICING"]}},{"name":"page-size","in":"query","description":"Pagination size","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","description":"Pagination offset cursor","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedResponsePublicPricingPlanResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OfferingErrorResponse"}}}}},"summary":"Get pricing plans by offering"}},"/v1/product-ignore-rule/{productId}/promotion-type/partner":{"get":{"tags":["Products"],"summary":"Get opt-out by product","parameters":[{"name":"productId","in":"path","description":"productId","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"hosting-type","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CLOUD","DATACENTER","SERVER"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicProductIgnoreRuleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v1/product-ignore-rule/promotion-type/partner":{"get":{"tags":["Products"],"summary":"Get products that opted out","parameters":[{"name":"hosting-type","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","enum":["CLOUD","DATACENTER","SERVER"]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPublicPromotionTypeIgnoreRuleResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PromotionErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/quotes/{id}":{"get":{"tags":["Quotes"],"summary":"Get quote by ID","operationId":"getQuote","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-Transaction-Account","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetQuoteResponseV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v1/entitlements/{entitlementId}/display-info":{"get":{"tags":["Entitlements"],"summary":"Get entitlements display info","parameters":[{"name":"entitlementId","in":"path","description":"Entitlement ID","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"X-Transaction-Account","in":"header","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DisplayInfoResponse"}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v1/quotes":{"get":{"tags":["Quotes"],"summary":"Get Quotes for a Transaction Account ID","parameters":[{"name":"X-transaction-account","in":"header","description":"The transaction account Id for which quotes are needed","required":true,"style":"simple","explode":false,"schema":{"type":"string","description":"The transaction account Id for which quotes are needed"}},{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":25,"minimum":1,"type":"integer","default":10}},{"name":"start-id","in":"query","description":"The start id of the paginated response","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"The start id of the paginated response"}},{"name":"status-filter","in":"query","description":"Returns the quotes with this particular status, quotes with all status within the Transaction Account Id will be returned if this is not set. The possible values for this field are : [ DRAFT, OPEN, ACCEPTED, CANCELLED, STALE ]","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Returns the quotes with this particular status, quotes with all status within the Transaction Account Id will be returned if this is not set. The possible values for this field are : [ DRAFT, OPEN, ACCEPTED, CANCELLED, STALE ]"}},{"name":"invoice-group","in":"query","description":"Returns the quotes having this invoice group Id, quotes with all invoice group ids within the Transaction Account Id will be returned if this is not set","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Returns the quotes having this invoice group Id, quotes with all invoice group ids within the Transaction Account Id will be returned if this is not set"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PublicPaginatedQuotesEntityGetQuoteResponseV2String"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v1/entitlements":{"get":{"tags":["Entitlements"],"summary":"Get entitlements for a transaction account ID","parameters":[{"name":"X-Transaction-Account","in":"header","description":"The transaction account id for which the entitlements are to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","description":"The transaction account id for which the entitlements are to be fetched"}},{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":25,"minimum":1,"type":"integer","default":10}},{"name":"start-id","in":"query","description":"The start id of the paginated response","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"The start id of the paginated response"}},{"name":"status-filter","in":"query","description":"Returns the entitlements having this status, entitlements with all status within the Transaction Account Id will be returned if this is not set. The possible values for this field are : [ ACTIVE, INACTIVE ]","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Returns the entitlements having this status, entitlements with all status within the Transaction Account Id will be returned if this is not set. The possible values for this field are : [ ACTIVE, INACTIVE ]"}},{"name":"invoice-group","in":"query","description":"Returns the entitlements having this invoice group id, entitlements with all invoice group id within the Transaction Account Id will be returned if this is not set.","required":false,"style":"form","explode":true,"schema":{"type":"string","description":"Returns the entitlements having this invoice group id, entitlements with all invoice group id within the Transaction Account Id will be returned if this is not set."}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDataResponseEntitlementSanitizedResponseDtoString"}}}},"207":{"description":"Multi-Status","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/orders":{"get":{"tags":["Orders"],"summary":"Get orders for a transaction account ID","parameters":[{"name":"page-size","in":"query","description":"Pagination size","required":false,"style":"form","explode":true,"schema":{"maximum":25,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","description":"Pagination offset cursor","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"invoice-group","in":"query","description":"Invoice group id","required":false,"style":"form","explode":true,"schema":{"type":"string"}},{"name":"X-transaction-account","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaginatedDataResponseDtoOrderGetResponseDtoV2String"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."},"post":{"tags":["Orders"],"summary":"Place order v2","parameters":[{"name":"X-transaction-account","in":"header","required":false,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"errorResponseVersion","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"v1","enum":["v1","v2"]}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OrderRequestDtoV2"},{"$ref":"#/components/schemas/OrderWithQuotesWebRequestDtoV2"}]}}},"required":true},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponseDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/invoice-groups":{"get":{"tags":["InvoiceGroups"],"description":"Get the n invoice groups of the transaction account\n\nRate limit: 600 requests per minute.","operationId":"getInvoiceGroups_1","parameters":[{"name":"X-transaction-account","in":"header","description":"Transaction Account","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"page-size","in":"query","required":false,"style":"form","explode":true,"schema":{"maximum":50,"minimum":1,"type":"integer","format":"int32","default":10}},{"name":"start-id","in":"query","required":false,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagedListV2InvoiceGroupPublicDto"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"security":[{"ASAP":[]}],"summary":"Get invoice groups for a transaction account ID"}},"/v1/entitlements/{entitlementId}/partner-acquisition-info":{"get":{"tags":["Entitlements"],"summary":"Get summary of an entitlement for partners","operationId":"getEntitlementSummaryForPartners","parameters":[{"name":"entitlementId","in":"path","description":"Entitlement ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Get Partner Acquisition Info","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntitlementSummary"}}}},"400":{"description":"Bad Request","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"404":{"description":"Not Found","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"412":{"description":"Precondition Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v2/order-intent/preview":{"post":{"tags":["Orders"],"summary":"Get order preview for quote","parameters":[{"name":"X-transaction-account","in":"header","required":true,"style":"simple","explode":false,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/OrderIntentWithQuoteWebRequestDtoV2"}]}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderGetResponseDtoV2"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"405":{"description":"Method Not Allowed","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"415":{"description":"Unsupported Media Type","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"422":{"description":"Unprocessable Entity","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"423":{"description":"Locked","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}},"501":{"description":"Not Implemented","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderServiceValidationErrorResponse"}}}}},"description":"Rate limit: 100 requests per minute."}},"/v3/quotes/{id}/download":{"get":{"tags":["Quotes"],"summary":"Download PDF for a Quote ID","operationId":"downloadQuoteV3","parameters":[{"name":"id","in":"path","required":true,"style":"simple","explode":false,"schema":{"type":"string"}},{"name":"transactionAccountId","in":"query","required":true,"style":"form","explode":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/pdf":{"schema":{"type":"string","format":"byte"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}}},"description":"Rate limit: 600 requests per minute."}},"/v1/invoices/{invoiceId}/download":{"get":{"tags":["Invoices"],"summary":"Download PDF for an invoice ID","operationId":"downloadInvoice","parameters":[{"name":"invoiceId","in":"path","description":"Invoice ID","required":true,"schema":{"type":"string"}},{"name":"transactionAccountId","in":"query","required":true,"schema":{"type":"string"}},{"name":"sourceSystem","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Downloaded invoice","content":{"application/pdf":{"schema":{"type":"string","format":"binary"}}}},"400":{"description":"Invalid id supplied","content":{}},"401":{"description":"Unauthorized","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"404":{"description":"invoice not found","content":{}},"412":{"description":"Precondition Failed","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"500":{"description":"Internal Server Error","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}},"503":{"description":"Service Unavailable","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ApiGatewayErrorResponse"}}}}},"description":"Rate limit: 200 requests per minute."}}},"components":{"schemas":{"InvoiceDto":{"required":["id","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"number":{"type":"string"},"invoiceGroup":{"type":"string"},"memo":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","OPEN","PAID","DEFERRED_PAID","PAYMENT_DEFERRED","UNCOLLECTIBLE","VOID"]},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"finalizedAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"dueAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"paidAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"uncollectibleAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"billTo":{"$ref":"#/components/schemas/BillToParty"},"shipTo":{"$ref":"#/components/schemas/ToPartyDto"},"paymentMethod":{"type":"string","description":"If not specified, will use the payment method defined for the invoice group.","nullable":true},"paymentMethodObj":{"oneOf":[{"$ref":"#/components/schemas/CreditCard"},{"$ref":"#/components/schemas/Deferred"},{"$ref":"#/components/schemas/PayPal"}]},"currency":{"type":"string","enum":["USD"]},"subtotal":{"type":"number"},"total":{"type":"number"},"tax":{"type":"number"},"taxIdLabel":{"type":"string"},"headerTaxId":{"type":"string"},"headerTaxIds":{"type":"array","items":{"$ref":"#/components/schemas/HeaderTaxId"}},"additionalNotes":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"dunningHistory":{"type":"array","items":{"$ref":"#/components/schemas/DunningStatus"}},"dunningStatus":{"$ref":"#/components/schemas/DunningStatus"},"purchaseOrderNumber":{"type":"string"},"appliedBalance":{"type":"number","description":"The customer balance applied on this invoice. If negative, the invoice total was reduced by this amount. If positive, the amount due was increased by this amount."},"reInvoiced":{"type":"boolean","nullable":true},"prePaymentCreditNotesAmount":{"type":"number","description":"The total amount of all pre-payment credit notes issued for this invoice."},"userDefinedNotes":{"type":"object","additionalProperties":{"type":"string"}},"paymentStatus":{"$ref":"#/components/schemas/PaymentStatus"}},"additionalProperties":false},"PaymentStatus":{"type":"object","properties":{"status":{"type":"string","enum":["NO_ACTION","REQUIRES_ACTION","REQUIRES_DIFFERENT_PAYMENT_METHOD"]},"updatedAt":{"type":"string","format":"date-time"},"message":{"type":"string"}},"additionalProperties":false},"DunningStatus":{"type":"object","properties":{"attempt":{"type":"string","enum":["ONE","TWO","THREE","FOUR","FIVE"]},"errorCode":{"type":"string"},"declineCode":{"type":"string"},"message":{"type":"string"},"updatedAt":{"type":"string","format":"date-time"},"nextPaymentAttemptDate":{"type":"string","format":"date-time"},"attemptCount":{"type":"integer","format":"int32"}},"additionalProperties":false},"InvoiceItem":{"type":"object","properties":{"id":{"type":"string"},"currency":{"type":"string","enum":["USD","JPY"]},"description":{"type":"string"},"period":{"$ref":"#/components/schemas/InvoicingPeriod"},"subtotal":{"type":"number"},"total":{"type":"number"},"quantity":{"type":"integer","format":"int64"},"unitAmount":{"type":"number"},"adjustments":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemAdjustment"}},"margins":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItemMargin"}},"taxItems":{"type":"array","items":{"$ref":"#/components/schemas/TaxItem"}},"invoiceRequest":{"type":"string"},"invoiceRequestItem":{"type":"integer","format":"int32","deprecated":true},"invoiceRequestItemId":{"type":"string"},"subscriptionObj":{"$ref":"#/components/schemas/InvoiceItemSubscription"},"planObj":{"$ref":"#/components/schemas/InvoiceRequestItemPlan"},"entitlementId":{"type":"string"},"entitlementNumber":{"type":"string"},"relationship":{"$ref":"#/components/schemas/Relationship"},"orderItemId":{"type":"string"},"offeringKey":{"type":"string"},"tax":{"type":"number"},"taxPercent":{"type":"number"},"originalInvoiceReferral":{"$ref":"#/components/schemas/OriginalInvoiceReferral"},"exchangeRate":{"type":"number"},"exchangeRateDate":{"type":"string","format":"date-time"},"proration":{"type":"boolean"},"metadata":{"$ref":"#/components/schemas/Metadata"},"orderId":{"type":"string"},"irIssuedTimestamp":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"accruedCharges":{"type":"boolean"}},"additionalProperties":false},"Metadata":{"type":"object","additionalProperties":false},"OriginalInvoiceReferral":{"type":"object","properties":{"invoice":{"type":"string","description":"Not set if the original referral has not yet invoiced due to 24 hour invoicing","nullable":true},"invoiceNumber":{"type":"string","description":"Not set if the original referral has not yet invoiced due to 24 hour invoicing","nullable":true},"transactionAccount":{"type":"string","description":"Transaction Account of the original invoice","nullable":true},"invoiceCreatedAt":{"type":"string","format":"date-time"},"invoiceItems":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"Relationship":{"type":"object","properties":{"relatesToEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementRelationship"}},"relatesFromEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementRelationship"}}},"additionalProperties":false},"EntitlementRelationship":{"type":"object","properties":{"relationshipType":{"type":"string"},"relationshipId":{"type":"string"},"entitlementId":{"type":"string"}},"additionalProperties":false},"Plan":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"sku":{"type":"string"},"hostingType":{"type":"string"},"cycle":{"$ref":"#/components/schemas/Cycle"}},"additionalProperties":false},"Cycle":{"type":"object","properties":{"interval":{"type":"string","enum":["MONTHLY","ANNUAL"]}},"additionalProperties":false},"Subscription":{"type":"object","properties":{"id":{"type":"string"},"versionInfo":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"entitlementId":{"type":"string"},"orderItemId":{"type":"string"},"version":{"type":"integer","format":"int64"},"stripeScheduleId":{"type":"string"},"orderId":{"type":"string"},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"offeringId":{"type":"string"},"lastPaidOfferingId":{"type":"string"},"pricingPlanId":{"type":"string"},"status":{"type":"string","enum":["PROCESSING","ACTIVE","CANCELLED"]},"promotionIds":{"type":"array","items":{"type":"string"}},"chargeQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"currentListPrice":{"type":"integer","format":"int64"},"previousListPrice":{"type":"integer","format":"int64"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"schedule":{"$ref":"#/components/schemas/Schedule"},"trialLengthDays":{"type":"integer","format":"int64"},"isEditable":{"type":"boolean"},"createdTimestamp":{"type":"integer","format":"int64"},"updatedTimestamp":{"type":"integer","format":"int64"},"startTimestamp":{"type":"integer","format":"int64"},"endTimestamp":{"type":"integer","format":"int64"},"billingAnchorTimestamp":{"type":"integer","format":"int64"},"currentBillingStartTimestamp":{"type":"integer","format":"int64"},"currentBillingEndTimestamp":{"type":"integer","format":"int64"},"nextBillingTimestamp":{"type":"integer","format":"int64"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64"},"cancelAtTheEndOfPeriod":{"type":"boolean"},"invoiceImmediately":{"type":"boolean"},"billingClockId":{"type":"string"},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}},"chargeQuantityList":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"trial":{"$ref":"#/components/schemas/Trial"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"}}},"PauseBilling":{"type":"object","properties":{"startTimestamp":{"type":"integer","description":"valid startTimestamp or null","format":"int64","nullable":true},"endTimestamp":{"type":"integer","description":"valid endTimeStamp or null","format":"int64","nullable":true}},"description":"valid pause billing change","nullable":true},"InvoiceSettings":{"type":"object","properties":{"preventUpcomingInvoice":{"type":"boolean","description":"to suppress the invoice from being sent to downstream CCP services. Will set this on invoice generated by the request"}},"description":"describe the invoice setting to be passed to the invoice created by the update","nullable":true},"Trial":{"type":"object","properties":{"startTimestamp":{"type":"integer","format":"int64"},"endTimestamp":{"type":"integer","format":"int64"},"pricingPlanId":{"type":"string"},"offeringId":{"type":"string"},"endBehaviour":{"type":"string","enum":["TRIAL_PLAN","BILLING_PLAN"]}},"description":"trial information for the subscription","nullable":true},"ChargeQuantity":{"required":["chargeElement","quantity"],"type":"object","properties":{"chargeElement":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"lastUpdatedAt":{"type":"integer","format":"int64"}},"description":"valid chargeQuantity"},"PromotionInstance":{"type":"object","properties":{"promotionInstanceId":{"type":"string","description":"the instanceId for an applied promotion","nullable":true},"promotionDefinition":{"$ref":"#/components/schemas/PromotionDefinition"}},"description":"valid promotionInstance","nullable":true},"PromotionDefinition":{"type":"object","properties":{"promotionId":{"type":"string","description":"the id of applied promotion","nullable":true},"promotionCode":{"type":"string","description":"the promotion code","nullable":true},"customisedValues":{"$ref":"#/components/schemas/CustomisedValues"}},"description":"the actual details of the promotion","nullable":true},"CustomisedValues":{"type":"object","properties":{"applicationReason":{"$ref":"#/components/schemas/ApplicationReason"},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/Benefit"}}},"additionalProperties":false},"Benefit":{"type":"object","properties":{"value":{"type":"number","format":"float"},"iterations":{"type":"integer","format":"int32"},"duration":{"type":"string","enum":["FOREVER","ONCE","REPEATING"]}},"additionalProperties":false},"ApplicationReason":{"type":"object","properties":{"id":{"type":"string"}},"additionalProperties":false},"Schedule":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"promotionIds":{"type":"array","items":{"type":"string"}},"startDate":{"type":"integer","format":"int64"},"systemOrderId":{"type":"string"},"latestInvoice":{"type":"string"},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}}}},"TaxItem":{"type":"object","properties":{"tax":{"type":"number"},"taxPercent":{"type":"number"},"taxAmountLabel":{"type":"string"}}},"InvoiceItemMargin":{"required":["amount","type"],"type":"object","properties":{"amount":{"type":"number"},"type":{"type":"string"},"percent":{"type":"number"},"promoCode":{"type":"string"},"promotionId":{"type":"string"},"reasonCode":{"type":"string"},"blended":{"type":"boolean"},"blendedComputation":{"$ref":"#/components/schemas/InvoiceItemMarginBlendedComputation"}},"additionalProperties":false},"InvoiceItemAdjustment":{"required":["amount","reason","type"],"type":"object","properties":{"reason":{"type":"string","deprecated":true},"reasonCode":{"type":"string"},"promotionId":{"type":"string"},"type":{"type":"string"},"amount":{"type":"number"},"percent":{"type":"number"},"promoCode":{"type":"string"}},"additionalProperties":false},"Period":{"required":["endAt","startAt"],"type":"object","properties":{"startAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"endAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"}},"additionalProperties":false},"HeaderTaxId":{"type":"object","properties":{"headerTaxID":{"type":"string"},"taxIdLabel":{"type":"string"}},"additionalProperties":false},"PayPal":{"required":["createdAt","currency","default","id","type","updatedAt"],"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentMethodPrivateDto"},{"type":"object","properties":{"payPal":{"$ref":"#/components/schemas/PayPalDto"}}}]},"PayPalDto":{"required":["email"],"type":"object","properties":{"name":{"type":"string"},"email":{"type":"string"},"merchantId":{"type":"string"},"country":{"type":"string"}},"additionalProperties":false},"PaymentMethodDto":{"required":["currency","default","id","type"],"type":"object","properties":{"currency":{"type":"string","description":"We currently only support USD.","example":"USD","enum":["USD"]},"type":{"type":"string","description":"Payment types are `CREDITCARD`, `DEFERRED`, or `PAYPAL`.","example":"CARD","enum":["CARD","DEFERRED","PAYPAL"]},"default":{"type":"boolean","description":"Deferred type is not allowed as default."},"id":{"type":"string"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"}},"discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/CreditCard","DEFERRED":"#/components/schemas/Deferred","PAYPAL":"#/components/schemas/PayPal"}}},"TransactionAccountPartitionDto":{"type":"object","properties":{"id":{"type":"string","description":"Transaction Account ID"},"partitionKey":{"type":"string","description":"Transaction Account Partition Key for the entity"}},"additionalProperties":false,"description":"Transaction Account Details associated with the entity"},"Deferred":{"required":["createdAt","currency","default","id","type","updatedAt"],"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentMethodPrivateDto"},{"type":"object","properties":{"terms":{"$ref":"#/components/schemas/Terms"}}}]},"Terms":{"type":"object","properties":{"invoiceDueDays":{"type":"integer","format":"int32","default":30},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"payOnStatement":{"type":"boolean"}},"additionalProperties":false},"CreditCard":{"required":["createdAt","currency","default","id","type","updatedAt"],"type":"object","allOf":[{"$ref":"#/components/schemas/PaymentMethodPrivateDto"},{"type":"object","properties":{"card":{"$ref":"#/components/schemas/CardDetails"}}}]},"CardDetails":{"required":["expMonth","expYear","funding","last4"],"type":"object","properties":{"brand":{"type":"string"},"country":{"type":"string"},"expMonth":{"type":"integer","format":"int64"},"expYear":{"type":"integer","format":"int64"},"funding":{"type":"string"},"last4":{"type":"string"},"cardHolderName":{"type":"string"},"postalCode":{"type":"string"}},"additionalProperties":false},"ToPartyDto":{"required":["name","postalAddress"],"type":"object","properties":{"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"id":{"type":"string","nullable":true},"version":{"type":"integer","format":"int64","nullable":true},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"}},"additionalProperties":false},"TaxId":{"type":"object","properties":{"id":{"type":"string"},"label":{"type":"string"},"taxIdLabel":{"type":"string"},"taxIdDescription":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}},"additionalProperties":false},"PostalAddress":{"required":["country"],"type":"object","properties":{"line1":{"maxLength":50,"minLength":0,"type":"string"},"line2":{"maxLength":100,"minLength":0,"type":"string"},"city":{"maxLength":50,"minLength":0,"type":"string"},"country":{"type":"string","description":"This field should follow ISO 3166-1 Alpha 2"},"state":{"type":"string"},"phone":{"type":"string"},"postcode":{"maxLength":11,"minLength":0,"type":"string"}},"additionalProperties":false},"BillToParty":{"required":["name","postalAddress"],"type":"object","properties":{"name":{"type":"string"},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"},"readOnly":true}},"additionalProperties":false},"ApiError":{"type":"object","properties":{"errorDetails":{"$ref":"#/components/schemas/ErrorDetails"},"errorKey":{"type":"string","enum":["RESOURCE_NOT_MODIFIED","BAD_REQUEST","REQUEST_VALIDATION_ERROR","PAYMENT_REQUIRED","RESOURCE_ACCESS_FORBIDDEN","RESOURCE_NOT_FOUND","RESOURCE_VERSION_NOT_MATCHED","CONFLICT","INTERNAL_SERVER_ERROR","SERVICE_UNAVAILABLE","NOT_IMPLEMENTED","TOO_MANY_REQUESTS"]}},"additionalProperties":false},"ErrorDetails":{"type":"object","additionalProperties":false,"oneOf":[{"$ref":"#/components/schemas/GenericErrorDetails"},{"$ref":"#/components/schemas/ValidationErrorDetails"}]},"ValidationErrorDetails":{"type":"object","properties":{"validationErrors":{"type":"array","items":{"$ref":"#/components/schemas/ValidationErrorMessage"}}},"additionalProperties":false},"ValidationErrorMessage":{"type":"object","properties":{"code":{"type":"string"},"fieldName":{"type":"string"},"validationMessage":{"type":"string"}},"additionalProperties":false},"GenericErrorDetails":{"required":["reason"],"type":"object","properties":{"reason":{"type":"string"}},"additionalProperties":false},"PagedListInvoiceDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceDto"}},"lastEvaluatedKey":{"type":"string","description":"Use the `lastEvaluatedKey` in your next `pageRequest` to continue paging from where the `PagedList` ended. If there weren't enough records left to fill up the `PagedList`, the value of `lastEvaluatedKey` will be null, so you won't have to continue paging.","nullable":true}},"additionalProperties":false},"PageRequest":{"type":"object","properties":{"startId":{"type":"string","description":"Use the value of lastEvaluatedKey returned in a PagedList in this parameter to continue paging from where the PagedList finished. If there weren't enough records left to search in order to fill up the previous PagedList completely, the value of lastEvaluatedKey will be null, therefore you dont have to continue paging."},"pageSize":{"maximum":1000,"minimum":0,"type":"integer","format":"int32","example":20,"default":20}},"additionalProperties":false},"InvoiceGroupDto":{"required":["createdAt","currency","id","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"name":{"type":"string","description":"An identifier to help customers/partners organize invoices.","nullable":true},"currency":{"type":"string","enum":["USD"]},"shipToParty":{"$ref":"#/components/schemas/ShipToPartyDto"},"billToParty":{"$ref":"#/components/schemas/BillToPartyDto"},"defaultPaymentMethod":{"type":"string","description":"If not specified, will use the transaction account payment method.","nullable":true},"purchaseOrder":{"$ref":"#/components/schemas/PurchaseOrder"},"memo":{"type":"string","nullable":true},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"recipients":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"PurchaseOrder":{"type":"object","properties":{"number":{"type":"string"},"oneTimeUse":{"type":"boolean"}},"additionalProperties":false},"BillToPartyDto":{"required":["name","postalAddress"],"type":"object","properties":{"name":{"type":"string"},"taxId":{"type":"string","description":"If the BillTo is not a legal entity the tax ID should be empty","nullable":true},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}}},"additionalProperties":false,"nullable":true},"ShipToPartyDto":{"required":["id","name","postalAddress","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"}},"additionalProperties":false},"OrderServiceValidationErrorResponse":{"type":"object","properties":{"title":{"type":"string"},"code":{"type":"string"},"detail":{"type":"string"},"status":{"type":"string"},"id":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemValidationErrorResponseDto"}},"couplingViolations":{"type":"array","items":{"$ref":"#/components/schemas/CouplingViolationResponse"}}}},"CouplingViolationResponse":{"type":"object","properties":{"violationCode":{"type":"string"},"message":{"type":"string"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}}},"Participant":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"}},"additionalProperties":false},"ItemValidationErrorResponseDto":{"type":"object","properties":{"itemId":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/LineItemValidationErrorResponseDto"}}},"additionalProperties":false},"LineItemValidationErrorResponseDto":{"type":"object","properties":{"errorCode":{"type":"string"},"message":{"type":"string"},"field":{"type":"string"}},"additionalProperties":false},"OrderGetResponseDto":{"type":"object","properties":{"orderId":{"type":"string"},"slug":{"type":"string"},"transactionAccountId":{"type":"string"},"transactionAccount":{"$ref":"#/components/schemas/TransactionAccountResponseDto"},"invoiceGroupId":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemGetResponseDto"}},"additionalTriggeredOrders":{"type":"array","items":{"$ref":"#/components/schemas/OrderGetResponseDto"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"createdDate":{"type":"integer","format":"int64"}}},"OrderItemGetResponseDto":{"type":"object","properties":{"orderItemId":{"type":"string"},"offeringId":{"type":"string"},"type":{"type":"string","enum":["CREATION_ORDER","AMENDMENT_ORDER","PATCH_ENTITLEMENT_DETAILS_ORDER","CANCELLATION_ORDER","SYSTEM_CANCELLATION_ORDER","SYSTEM_AMENDMENT_ORDER","REACTIVATION_ORDER","ACCOUNT_MODIFICATION_ORDER","REWIND_ORDER","REVERT_TRIAL_ORDER","REBILL_ORDER","TRANSITION_ORDER","TRANSFER_IN_ORDER","TRANSFER_OUT_ORDER"]},"parentEntitlementId":{"type":"string"},"optedUsageOptions":{"$ref":"#/components/schemas/OptedUsageOptionDto"},"billingOptions":{"$ref":"#/components/schemas/BillingOptionsDto"},"processingInfo":{"$ref":"#/components/schemas/ProcessingInfo"},"triggeredByOrderItem":{"$ref":"#/components/schemas/OrderItemRefDto"},"reasonCode":{"type":"string"},"featureOverrides":{"type":"object","additionalProperties":{"type":"object"}},"isImmediate":{"type":"boolean","nullable":true},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDto"}},"quoteLineItemDetailsReference":{"$ref":"#/components/schemas/QuoteLineItemDetailsReferenceDto"},"originalOrderItemId":{"type":"string","description":"Points to an `orderItemId` which is executed in `SYSTEM_ORDER`."},"transition":{"$ref":"#/components/schemas/TransitionDto"},"subscriptionStartTime":{"type":"integer","format":"int64"},"billingAnchorTime":{"type":"integer","format":"int64"},"rewindToOrderItemId":{"type":"string"},"backdateTimestamp":{"type":"integer","format":"int64"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64"},"rebillOptions":{"$ref":"#/components/schemas/RebillOptionsDto"},"migrationEntitlementHistory":{"$ref":"#/components/schemas/MigrationEntitlementHistoryDto"},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RelatesFromEntitlementResponseDto"},{"$ref":"#/components/schemas/RelatesFromOrderItemResponseDto"}]}}}},"RelatesFromOrderItemResponseDto":{"required":["orderItemId"],"type":"object","allOf":[{"$ref":"#/components/schemas/RelatesFromResponseDto"},{"type":"object","properties":{"orderItemId":{"type":"string"}}}]},"RelatesFromResponseDto":{"type":"object","properties":{"relationshipType":{"type":"string"},"referenceType":{"type":"string","enum":["ORDER_ITEM","ENTITLEMENT"]}},"discriminator":{"propertyName":"referenceType","mapping":{"ORDER_ITEM":"#/components/schemas/RelatesFromOrderItemResponseDto","ENTITLEMENT":"#/components/schemas/RelatesFromEntitlementResponseDto"}}},"RelatesFromEntitlementResponseDto":{"required":["entitlementId"],"type":"object","allOf":[{"$ref":"#/components/schemas/RelatesFromResponseDto"},{"type":"object","properties":{"entitlementId":{"type":"string"}}}]},"MigrationEntitlementHistoryDto":{"type":"object","properties":{"lastPaidOfferingLevel":{"type":"integer","format":"int32","nullable":true},"glpForLastPaidPlan":{"type":"integer","format":"int64","nullable":true},"lastInvoiceId":{"type":"string","nullable":true},"lastInvoiceCreationDate":{"type":"integer","format":"int64","nullable":true},"sourceSystem":{"type":"string","nullable":true,"enum":["HAMS","CCP","CCP_OMS"]},"creationTimestamp":{"type":"integer","format":"int64","nullable":true},"firstInvoiceStartTimestamp":{"type":"integer","format":"int64","nullable":true},"firstInvoiceEndTimestamp":{"type":"integer","format":"int64","nullable":true},"originalEntitlementId":{"type":"string","nullable":true},"originalParentEntitlementId":{"type":"string","nullable":true}},"nullable":true},"RebillOptionsDto":{"type":"object","properties":{"billFromTimestamp":{"type":"integer","format":"int64"}},"nullable":true},"TransitionDto":{"required":["applyAfterTimestamp","offering"],"type":"object","properties":{"offering":{"$ref":"#/components/schemas/OfferingTransitionDto"},"pricingPlan":{"$ref":"#/components/schemas/PricingPlanTransitionDto"},"applyAfterTimestamp":{"type":"integer","format":"int64"}}},"PricingPlanTransitionDto":{"type":"object","properties":{"from":{"type":"string","format":"uuid","nullable":true},"to":{"type":"string","format":"uuid","nullable":true}},"nullable":true},"OfferingTransitionDto":{"type":"object","properties":{"from":{"type":"string","format":"uuid","nullable":true},"to":{"type":"string","format":"uuid","nullable":true}}},"QuoteLineItemDetailsReferenceDto":{"type":"object","properties":{"quoteId":{"type":"string"},"version":{"type":"integer","format":"int64"},"quoteLineItemId":{"type":"string"}}},"OmsPromotionDto":{"type":"object","properties":{"promotionInstanceId":{"type":"string","nullable":true},"promotionDefinition":{"$ref":"#/components/schemas/PromotionDefinitionDto"}}},"PromotionDefinitionDto":{"type":"object","properties":{"promotionId":{"type":"string","format":"uuid","nullable":true},"promotionCode":{"type":"string","nullable":true},"customisedValues":{"$ref":"#/components/schemas/CustomPromotionValueDto"}},"nullable":true},"CustomPromotionValueDto":{"type":"object","properties":{"applicationReason":{"$ref":"#/components/schemas/ApplicationReasonDto"},"benefits":{"type":"array","items":{"$ref":"#/components/schemas/PromotionBenefitDto"}}},"nullable":true},"PromotionBenefitDto":{"type":"object","properties":{"value":{"type":"number","description":"Value needs to be whole number","format":"float","nullable":true},"iterations":{"type":"integer","description":"iterations is required only for REPEATING Duration","format":"int32","nullable":true},"duration":{"type":"string","nullable":true,"enum":["FOREVER","ONCE","REPEATING","VARIABLE"]}}},"ApplicationReasonDto":{"type":"object","properties":{"id":{"type":"string"}},"nullable":true},"OrderItemRefDto":{"type":"object","properties":{"orderId":{"type":"string"},"orderItemId":{"type":"string"}}},"ProcessingInfo":{"type":"object","properties":{"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"status":{"type":"string","enum":["PROCESSING","SUCCESS","FAIL"]},"transitionTime":{"type":"string","enum":["IMMEDIATE","NEXT_CYCLE","SCHEDULED"]},"transitionTimestamp":{"type":"integer","format":"int64"},"saleTransitionType":{"type":"string","enum":["NEW","NA","DOWNGRADE","UPGRADE","RENEW"]},"saleTransitionDetails":{"$ref":"#/components/schemas/SaleTransitionDetailsDto"},"accountModification":{"$ref":"#/components/schemas/AccountModificationDto"},"computedDetails":{"$ref":"#/components/schemas/ComputedDetails"},"impactedEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/ImpactedEntitlementDto"}},"additionalTriggeredOrderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemRefDto"}},"prorationBehaviour":{"type":"string","enum":["NONE","ALWAYS_INVOICE"]}}},"ImpactedEntitlementDto":{"type":"object","properties":{"version":{"type":"string"},"order":{"$ref":"#/components/schemas/ImplicitOrderDto"},"entitlementId":{"type":"string"}}},"ImplicitOrderDto":{"type":"object","properties":{"offeringId":{"type":"string"},"orderType":{"type":"string","enum":["CREATION_ORDER","AMENDMENT_ORDER","PATCH_ENTITLEMENT_DETAILS_ORDER","CANCELLATION_ORDER","SYSTEM_CANCELLATION_ORDER","SYSTEM_AMENDMENT_ORDER","REACTIVATION_ORDER","ACCOUNT_MODIFICATION_ORDER","REWIND_ORDER","REVERT_TRIAL_ORDER","REBILL_ORDER","TRANSITION_ORDER","TRANSFER_IN_ORDER","TRANSFER_IN_CREATE_ORDER","TRANSFER_OUT_ORDER","SYSTEM_PATCH_ENTITLEMENT_DETAILS_ORDER"]}}},"ComputedDetails":{"type":"object","properties":{"offeringId":{"type":"string"},"computedEndTimestamp":{"type":"integer","format":"int64"},"computedBillUntilTimestamp":{"type":"integer","format":"int64"},"usageOptions":{"$ref":"#/components/schemas/OptedUsageOptionDto"},"removedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDto"}},"orderedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDto"}},"replacedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDto"}},"pricingPlanTransition":{"$ref":"#/components/schemas/PricingPlanTransitionDto"}}},"OptedUsageOptionDto":{"type":"object","properties":{"trial":{"$ref":"#/components/schemas/TrialIntentDto"},"chargingDetails":{"$ref":"#/components/schemas/ChargingDetailsDto"},"purchaseMetadata":{"maxProperties":10,"type":"object","additionalProperties":{"maxProperties":10,"type":"string"}},"effectiveTime":{"$ref":"#/components/schemas/EffectiveTimeDto"},"billingBehaviour":{"$ref":"#/components/schemas/BillingBehaviourDto"}},"nullable":true},"BillingBehaviourDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["PAUSE_BILLING"]},"startTimestamp":{"type":"integer","format":"int64"}},"nullable":true},"EffectiveTimeDto":{"required":["endsAt"],"type":"object","properties":{"startsAt":{"$ref":"#/components/schemas/StartsAtEffectiveTimeDto"},"endsAt":{"$ref":"#/components/schemas/EndsAtEffectiveTimeDto"}},"nullable":true},"EndsAtEffectiveTimeDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["TIMESTAMP","DURATION"]},"endTimestamp":{"type":"integer","format":"int64"},"billingFrequencyCount":{"type":"integer","format":"int32"}}},"ChargingDetailsDto":{"type":"object","properties":{"pricingPlanId":{"type":"string","description":"Blank/Empty String will be treated as null","format":"uuid","nullable":true},"chargeQuantities":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ChargeQuantityDto"}}},"nullable":true},"ChargeQuantityDto":{"required":["chargeElement","quantity"],"type":"object","properties":{"chargeElement":{"type":"string"},"quantity":{"type":"integer","format":"int64"}},"additionalProperties":false,"description":"Charge quantities for which customer is purchasing/amending a subscription"},"TrialIntentDto":{"type":"object","properties":{"skipTrial":{"type":"boolean","nullable":true},"behaviourAtEndOfTrial":{"type":"string","enum":["CONVERT_TO_PAID","CANCEL","REVERT_TRIAL"]},"endTimestamp":{"type":"integer","format":"int64","nullable":true},"offeringId":{"type":"string","nullable":true},"pricingPlanId":{"type":"string","nullable":true},"startTimestamp":{"type":"integer","format":"int64","nullable":true}},"nullable":true},"AccountModificationDto":{"type":"object","properties":{"invoiceGroupId":{"type":"string","format":"uuid","nullable":true},"transactionAccountId":{"type":"string","nullable":true}},"description":"Provide invoiceGroupId or transactionAccountId or Both"},"SaleTransitionDetailsDto":{"type":"object","properties":{"glpForLastPaidPlan":{"type":"integer","format":"int64"},"glpForCurrentPlan":{"type":"integer","format":"int64"},"glpForNextPlan":{"type":"integer","format":"int64"},"glpForNextPlanLegacyPricing":{"type":"integer","format":"int64"},"currentOfferingLevel":{"type":"integer","format":"int32"},"nextOfferingLevel":{"type":"integer","format":"int32"},"saleTransitionType":{"type":"string","enum":["NEW","NA","DOWNGRADE","UPGRADE","RENEW"]},"lastPaidOfferingLevel":{"type":"integer","format":"int32"},"saleTransitionTime":{"type":"string","nullable":true,"enum":["IMMEDIATE","NEXT_CYCLE"]},"glpForAllPhases":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/GLPPhaseDto"}},"currency":{"type":"string"}}},"GLPPhaseDto":{"type":"object","properties":{"glp":{"type":"integer","format":"int64"},"offeringId":{"type":"string"}},"nullable":true},"OrderEntitlementRefDto":{"required":["id","version"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"type":"string"}}},"BillingOptionsDto":{"type":"object","properties":{"preBill":{"$ref":"#/components/schemas/PrebillDto"}},"nullable":true},"PrebillDto":{"required":["billUntil"],"type":"object","properties":{"billUntil":{"$ref":"#/components/schemas/BillUntilDto"}},"nullable":true},"BillUntilDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["TIMESTAMP_REFERENCE","DURATION","TIMESTAMP"]},"duration":{"$ref":"#/components/schemas/Duration"},"timestamp":{"type":"integer","format":"int64","nullable":true},"reference":{"type":"string","nullable":true,"enum":["END_TIME"]}}},"Duration":{"type":"object","properties":{"intervalCount":{"type":"integer","format":"int64"},"interval":{"type":"string","enum":["YEAR","MONTH"]}}},"TransactionAccountResponseDto":{"type":"object","properties":{"id":{"type":"string"},"partitionKey":{"type":"string"}}},"ErrorResponse":{"type":"object","properties":{"status":{"type":"string"},"message":{"type":"string"},"errorCode":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/ItemValidationErrorResponseDto"}},"couplingViolations":{"type":"array","items":{"$ref":"#/components/schemas/LicenseCouplingViolationErrorResponse"}}},"additionalProperties":false},"LicenseCouplingViolationErrorResponse":{"type":"object","properties":{"violationCode":{"type":"string"},"message":{"type":"string"},"participants":{"type":"array","items":{"$ref":"#/components/schemas/Participant"}}},"additionalProperties":false},"GetQuoteResponse":{"required":["createdAt","createdBy","estimateRequestedAt","id","invoiceGroupId","lineItems","name","number","reasonCode","revision","status","transactionAccountId","upcomingBillsRequestedAt","version"],"type":"object","properties":{"id":{"type":"string","description":"ID for the quote in UUID format."},"version":{"type":"integer","description":"The latest version of the quote.","format":"int32"},"contractType":{"type":"string","description":"Quote contract type specifying whether it's a standard or non-standard quote.","enum":["STANDARD","NON_STANDARD"]},"name":{"type":"string","description":"Name of the quote that customer will specify in the UI."},"number":{"type":"string","description":"Human-readable ID for the quote."},"fromQuote":{"type":"string","description":"The reference quote that the current quote was cloned or revised from."},"expiresAt":{"type":"integer","description":"The time in epoch time after which the quote will expire.","format":"int64"},"expiresAfterDays":{"type":"integer","description":"The number of days after which the quote should expire when it's finalized.","format":"int32"},"revision":{"type":"integer","description":"The number of times this quote has been revised.","format":"int32"},"locale":{"type":"string","description":"The language in which the quote should be presented to customers on page or in a PDF. The default value is `en-US`."},"status":{"type":"string","description":"Current state of a quote.","enum":["VALIDATION_IN_PROGRESS","CREATION_IN_PROGRESS","FINALIZATION_IN_PROGRESS","ACCEPTANCE_IN_PROGRESS","CANCELLATION_IN_PROGRESS","CLONING_IN_PROGRESS","REVISION_IN_PROGRESS","DRAFT","UPDATE_IN_PROGRESS","OPEN","CANCELLED","STALE","ACCEPTED"]},"reasonCode":{"type":"string","description":"Stores information on how a quote arrived at the current status."},"transactionAccountId":{"type":"string","description":"The destination transaction account for the customer for which a quote is created."},"invoiceGroupId":{"type":"string","description":"Invoice group with which the subscription will be associated once the quote is finalized."},"externalNotes":{"type":"array","description":"External notes that customers can view, but can only be edited by CAs.","items":{"$ref":"#/components/schemas/NoteDto"}},"internalNotes":{"type":"array","description":"Internal notes that can't be seen by the customer.","deprecated":true,"items":{"$ref":"#/components/schemas/NoteDto"}},"createdAt":{"type":"integer","description":"Timestamp at which a quote was created.","format":"int64"},"createdBy":{"$ref":"#/components/schemas/AuthorContextDto"},"updatedAt":{"type":"integer","description":"Timestamp at which a quote was last updated.","format":"int64"},"updatedBy":{"$ref":"#/components/schemas/AuthorContextDto"},"lineItems":{"type":"array","description":"Individual quote line items which contains unique product, pricing plan, subscription information, and so on.","items":{"$ref":"#/components/schemas/LineItemResponse"}},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for the quote."},"description":"Metadata for the quote."},"finalizedAt":{"type":"integer","description":"The date time in milliseconds when the quote was finalized.","format":"int64"},"acceptanceKey":{"type":"string","description":"Acceptance key for the quote.","deprecated":true},"estimateRequestedAt":{"type":"integer","description":"Timestamp at which estimations were requested.","format":"int64","deprecated":true},"estimateComputedAt":{"type":"integer","description":"Timestamp at which estimations were computed.","format":"int64","deprecated":true},"estimates":{"$ref":"#/components/schemas/EstimateResponse"},"upcomingBillsRequestedAt":{"type":"integer","description":"Timestamp at which upcoming bills were requested.","format":"int64"},"upcomingBillsComputedAt":{"type":"integer","description":"Timestamp at which upcoming bills were computed.","format":"int64"},"upcomingBills":{"$ref":"#/components/schemas/UpcomingBillsResponse"},"staleReason":{"$ref":"#/components/schemas/StaleReasonResponse"},"cancelledReason":{"$ref":"#/components/schemas/CanceledReasonResponse"}},"additionalProperties":false},"CanceledReasonResponse":{"type":"object","properties":{"code":{"type":"string","description":"Reason code for moving to the state"},"name":{"type":"string","description":"Reason for moving to the state"},"lastUpdatedAt":{"type":"integer","description":"Timestamp when the status reason code was last updated","format":"int64"},"orderId":{"type":"string","description":"Order id for quote moving to cancel status"},"orderItemId":{"type":"string","description":"Order item id for quote moving to cancel status"}},"additionalProperties":false,"description":"Reason for quote cancellation"},"StaleReasonResponse":{"type":"object","properties":{"code":{"type":"string","description":"Reason code for moving to the state"},"name":{"type":"string","description":"Reason for moving to the state"},"lastUpdatedAt":{"type":"integer","description":"Timestamp when the status reason code was last updated","format":"int64"},"expiresAt":{"type":"integer","description":"Timestamp when the status will expire","format":"int64"},"orderId":{"type":"string","description":"Order id for quote moving to stale status"},"orderItemId":{"type":"string","description":"Order item id for quote moving to stale status"}},"additionalProperties":false,"description":"Reason for quote moving to stale status"},"UpcomingBillsResponse":{"type":"object","properties":{"tax":{"type":"number","description":"Sum of tax in upcoming bills of all line items"},"total":{"type":"number","description":"The total estimate for the quote."},"subTotal":{"type":"number","description":"Sum of subtotal of all line items excluding tax, promotions."},"lines":{"type":"array","description":"Upcoming Bills values for Quote Line Items","items":{"$ref":"#/components/schemas/UpcomingBillsLineResponse"}}},"additionalProperties":false,"description":"Upcoming Bills values for the quote"},"UpcomingBillsLineResponse":{"type":"object","properties":{"id":{"type":"string","description":"Id for the upcoming bills line item"},"quoteLineId":{"type":"string","description":"Id for the quote line item"},"description":{"type":"string","description":"Estimate Description"},"currency":{"type":"string","description":"Three-letter ISO currency code","enum":["USD"]},"total":{"type":"number","description":"Upcoming Bills line total"},"subTotal":{"type":"number","description":"Cost of the line item excluding tax, promotions and upgrade credits"},"tax":{"type":"number","description":"Tax on the line item of upcoming bill"},"period":{"$ref":"#/components/schemas/PeriodResponse"},"offeringId":{"type":"string","description":"Product Offering referred in the quote"},"pricingPlanId":{"type":"string","description":"This will store the reference pricing plan id which will determine the list price of the product"},"quantity":{"type":"integer","description":"The quantity for which the user is charged.","format":"int64"},"adjustments":{"type":"array","description":"Discount details for the line item","items":{"$ref":"#/components/schemas/AdjustmentDetailResponse"}},"margins":{"type":"array","description":"Margins for the line item","items":{"$ref":"#/components/schemas/MarginResponse"}},"taxItems":{"type":"array","description":"Tax distribution for the line item","items":{"$ref":"#/components/schemas/TaxItemsResponse"}},"taxPercent":{"type":"number","description":"Percentage value of tax for the line item"},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for upcoming bills line for a quote line item"},"description":"Metadata for upcoming bills line for a quote line item"}},"additionalProperties":false,"description":"Upcoming Bills values for Quote Line Items"},"TaxItemsResponse":{"type":"object","properties":{"tax":{"type":"number","description":"Tax value for the tax item"},"taxAmountLabel":{"type":"string","description":"Tax label for the tax item"},"taxPercent":{"type":"number","description":"Percentage value of tax for the tax item"}},"additionalProperties":false,"description":"Tax distribution for the line item"},"MarginResponse":{"type":"object","properties":{"promotionId":{"type":"string","description":"Promotion ID for a Margin in the line item"},"amount":{"type":"number","description":"Margin Amount for a Margin in the line item"},"percent":{"type":"number","description":"Percent Off for a Margin in the line item"},"reasonCode":{"type":"string","description":"Reason Code for a Margin in the line item"},"type":{"type":"string","description":"Type of margin"},"promoCode":{"type":"string","description":"Promo code used for Marketplace addons"},"blended":{"type":"boolean","description":"Returns true if blended margin is applied"},"blendedComputation":{"$ref":"#/components/schemas/BlendedMarginComputation"}},"additionalProperties":false,"description":"Margins for the line item"},"AdjustmentDetailResponse":{"type":"object","properties":{"promotionId":{"type":"string","description":"Promotion ID for a Discount in the line item"},"amount":{"type":"number","description":"Discount Amount for a Discount in the line item"},"percent":{"type":"number","description":"Percent Off for a Discount in the line item"},"reasonCode":{"type":"string","description":"Reason Code for a Discount in the line item"},"type":{"type":"string","description":"Discount Type for a Discount in the line item"},"promoCode":{"type":"string","description":"Promo Code for a Discount in the line item"}},"additionalProperties":false,"description":"Discount details for the line item"},"PeriodResponse":{"type":"object","properties":{"endsAt":{"type":"integer","description":" The end timestamp of the period","format":"int64"},"startsAt":{"type":"integer","description":" The start timestamp of the period","format":"int64"}},"additionalProperties":false,"description":"The period for which the upcoming bills line is generated"},"EstimateResponse":{"type":"object","properties":{"taxEstimate":{"type":"number","description":"Sum of tax estimates of all line items."},"total":{"type":"number","description":"The total estimate for the quote."},"subTotal":{"type":"number","description":"Sum of subtotals of all line items excluding tax and promotions."},"estimateLines":{"type":"array","description":"Estimate values for quote line items.","items":{"$ref":"#/components/schemas/EstimateLineResponse"}}},"additionalProperties":false,"description":"Estimate values for the quote."},"EstimateLineResponse":{"type":"object","properties":{"id":{"type":"string","description":"ID for the estimate line item."},"quoteLineId":{"type":"string","description":"ID for the quote line item."},"description":{"type":"string","description":"Estimate description."},"currency":{"type":"string","description":"Three-letter ISO currency code.","enum":["USD"]},"total":{"type":"number","description":"Estimate line total."},"subTotal":{"type":"number","description":"Cost of the line item excluding tax, promotions, and upgrade credits."},"taxEstimate":{"type":"number","description":"Tax estimate of the line item."},"period":{"$ref":"#/components/schemas/PeriodResponse"},"offeringId":{"type":"string","description":"Product offering referred to in the quote."},"pricingPlanId":{"type":"string","description":"Stores the reference pricing plan ID, which determines the list price of the product."},"quantity":{"type":"integer","description":"The quantity for which the user is charged.","format":"int64"},"discountDetails":{"type":"array","description":"Discount details for the line item.","items":{"$ref":"#/components/schemas/DiscountDetailResponse"}},"margins":{"type":"array","description":"Margins for the line item.","items":{"$ref":"#/components/schemas/MarginResponse"}},"taxItems":{"type":"array","description":"Tax distribution for the line item.","items":{"$ref":"#/components/schemas/TaxItemsResponse"}},"taxPercent":{"type":"number","description":"Percentage value of tax for the line item."},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for estimate line for a quote line item."},"description":"Metadata for estimate line for a quote line item."}},"additionalProperties":false,"description":"Estimate values for quote line items."},"DiscountDetailResponse":{"type":"object","properties":{"promotionId":{"type":"string","description":"Promotion ID for a discount in the line item."},"discountAmount":{"type":"number","description":"Discount amount for a discount in the line item."},"percentOff":{"type":"number","description":"Percent off for a discount in the line item."},"reasonCode":{"type":"string","description":"Reason code for a discount in the line item."},"discountType":{"type":"string","description":"Discount type for a discount in the line item."},"promotionCode":{"type":"string","description":"Promo code for a discount in the line item."}},"additionalProperties":false},"LineItemResponse":{"required":["lineItemId","lineItemType","offeringKey"],"type":"object","properties":{"lineItemId":{"type":"string","description":"Id for the quote line item"},"entitlementId":{"type":"string","description":"Valid entitlement id for which the amendment quote is created"},"entitlementVersion":{"type":"string","description":"Version of the entitlement id for which the amendment quote is created"},"lineItemType":{"type":"string","description":"Type for the line item","enum":["CREATE_ENTITLEMENT","AMEND_ENTITLEMENT","ACCOUNT_MODIFICATION","REACTIVATE_ENTITLEMENT"]},"prorationBehaviour":{"type":"string","description":"Proration behaviour for the quote line item","enum":["CREATE_PRORATIONS","NONE"]},"offeringKey":{"type":"string","description":"Product Offering referred in the quote"},"pricingPlanId":{"type":"string","description":"This will store the reference pricing plan id which will determine the list price of the product"},"chargeQuantities":{"type":"array","description":"Charge quantities for which customer is purchasing/amending a subscription","items":{"$ref":"#/components/schemas/ChargeQuantityDto"}},"promotions":{"type":"array","description":"This is a field, which will store promotions information","items":{"$ref":"#/components/schemas/PromotionResponseDto"}},"relatesFromEntitlements":{"type":"array","description":"Used to specify whether relating to an existing entitlement or lineItem in the same quote request","items":{"$ref":"#/components/schemas/RelatesFromEntitlementDetails"}},"lockContext":{"$ref":"#/components/schemas/LockContextDto"},"skipTrial":{"type":"boolean","description":"Flag to specify whether we want to skip trial for this line item"},"orderItemId":{"type":"string","description":"Order Item ID for the line item"},"subscriptionId":{"type":"string","description":"Subscription ID for the line item"},"startsAt":{"$ref":"#/components/schemas/StartsAtDto"},"billingAnchor":{"$ref":"#/components/schemas/BillingAnchorDto"},"endsAt":{"$ref":"#/components/schemas/LineItemEndsAtDto"},"status":{"type":"string","description":"Cancelled or stale state of a quote line item","enum":["STALE","CANCELLED"]},"staleReason":{"$ref":"#/components/schemas/LineStaleStatusReasonResponse"},"cancelledReason":{"$ref":"#/components/schemas/LineCancelledStatusReasonResponse"},"preBillingConfiguration":{"$ref":"#/components/schemas/PreBillingConfigurationDto"},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for the quote Line Item"},"description":"Metadata for the quote Line Item"}},"additionalProperties":false,"description":"Individual quote line items which contains unique product, pricing plan, existing subscription information etc"},"PreBillingConfigurationDto":{"required":["billFrom","billTo"],"type":"object","properties":{"billFrom":{"$ref":"#/components/schemas/BillFromDto"},"billTo":{"$ref":"#/components/schemas/BillToDto"}},"additionalProperties":false,"description":"Pre-Bill configuration of the quote line item"},"BillToDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Pre-Bill configuration for subscriptions of the Line Item can be of type : DURATION OR TIMESTAMP","enum":["DURATION","TIMESTAMP"]},"duration":{"$ref":"#/components/schemas/BillToDurationDto"},"timestamp":{"type":"integer","description":"Timestamp till which to pre-bill","format":"int64"}},"additionalProperties":false,"description":"Subscription Pre-Bill To configuration"},"BillToDurationDto":{"required":["interval","intervalCount"],"type":"object","properties":{"interval":{"type":"string","description":"Subscription Pre-Bill To Duration's Interval Type. Currently only supports year","enum":["YEAR"]},"intervalCount":{"minimum":1,"type":"integer","description":"Subscription Pre-Bill To Duration's Interval Count","format":"int32"}},"additionalProperties":false,"description":"Duration till which to pre-bill. Currently only supports year as the duration"},"BillFromDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Pre-Bill Start of Subscription can be of type : QUOTE_ACCEPTANCE_DATE OR UPCOMING_INVOICE","enum":["QUOTE_ACCEPTANCE_DATE","UPCOMING_INVOICE","TIMESTAMP"]},"timestamp":{"type":"integer","description":"Start Timestamp from where to pre-bill in milliseconds","format":"int64"}},"additionalProperties":false,"description":"Subscription Pre-Bill From configuration"},"LineStatusReasonResponse":{"type":"object","properties":{"code":{"type":"string","description":"Reason code for moving to the state"},"name":{"type":"string","description":"Reason for moving to the state"},"lastUpdatedAt":{"type":"integer","description":"Timestamp when the status reason code was last updated","format":"int64"}},"additionalProperties":false,"description":"Reason for quote line item to move to cancel state"},"LineItemEndsAtDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Subscription End for TERMED Subscriptions of the Line Item can be of type : DURATION OR TIMESTAMP","enum":["DURATION","TIMESTAMP"]},"duration":{"$ref":"#/components/schemas/DurationDto"},"timestamp":{"type":"integer","description":"Term End Date for TERMED Subscription","format":"int64"}},"additionalProperties":false,"description":"Subscription End Date for TERMED Subscriptions of the Line Item"},"DurationDto":{"required":["interval","intervalCount"],"type":"object","properties":{"interval":{"type":"string","description":"Subscription End Duration's Interval Type. Currently only supports year","enum":["YEAR"]},"intervalCount":{"minimum":1,"type":"integer","description":"Subscription End Duration's Interval Count","format":"int32"}},"additionalProperties":false,"description":"Duration after which TERMED Subscription ends. Currently only supports year as the duration"},"BillingAnchorDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","description":"Billing Anchor of Line Item can be of type : QUOTE_ACCEPTANCE_DATE OR TIMESTAMP","enum":["QUOTE_ACCEPTANCE_DATE","UPCOMING_INVOICE","TIMESTAMP"]},"timestamp":{"type":"integer","description":"Billing Anchor Timestamp of Line Item","format":"int64"}},"additionalProperties":false,"description":"Billing Anchor of the Line Item"},"StartsAtDto":{"type":"object","properties":{"type":{"type":"string","description":"Subscription Start of Line Item can be of type : QUOTE_ACCEPTANCE_DATE OR UPCOMING_INVOICE OR TIMESTAMP","enum":["QUOTE_ACCEPTANCE_DATE","UPCOMING_INVOICE","TIMESTAMP"]},"timestamp":{"type":"integer","description":"Subscription Start timestamp for a Line Item in milliseconds","format":"int64"}},"additionalProperties":false,"description":"Subscription Start Date of the Line Item"},"LockContextDto":{"type":"object","properties":{"isPriceLocked":{"type":"boolean"},"isPromotionLocked":{"type":"boolean","deprecated":true}},"additionalProperties":false},"RelatesFromEntitlementDetails":{"required":["referenceType","relationshipType"],"type":"object","properties":{"referenceType":{"type":"string","description":"Used to specify whether relating to an existing entitlementId or lineItemId in the same quote request","enum":["ENTITLEMENT","LINE_ITEM"]},"entitlementId":{"type":"string","description":"EntitlementId of the existing entitlement, if referenceType selected is ENTITLEMENT."},"lineItemId":{"type":"string","description":"LineItemId of the other line item of type CREATE_ENTITLEMENT in the same Quote request, to whose entitlement you want to link the entitlement in this quote line item."},"relationshipType":{"type":"string","description":"Link the referenced entitlement to the entitlement created in the lineItem with this relationshipType."}},"additionalProperties":false},"PromotionResponseDto":{"type":"object","properties":{"promotionInstanceId":{"type":"string"},"promotionDefinition":{"$ref":"#/components/schemas/PromotionResponseDefinition"}},"additionalProperties":false,"description":"This is a field, which will store promotions information"},"PromotionResponseDefinition":{"type":"object","properties":{"promotionId":{"type":"string"},"promotionCode":{"type":"string"},"customisedValues":{"$ref":"#/components/schemas/CustomisedValues"},"applicationContext":{"$ref":"#/components/schemas/ApplicationContext"}},"additionalProperties":false},"ApplicationContext":{"type":"object","properties":{"promotionLock":{"type":"boolean"}},"additionalProperties":false},"AuthorContextDto":{"type":"object","properties":{"subject":{"type":"string"},"subjectType":{"type":"string"},"isCustomerAdvocate":{"type":"boolean"},"isSystemDrivenAction":{"type":"boolean"}},"additionalProperties":false,"description":"AAID for user last updating the quote"},"NoteDto":{"type":"object","properties":{"note":{"type":"string"},"createdAt":{"type":"integer","format":"int64"}},"additionalProperties":false,"description":"External notes that customer can view but can only be edited by CAs"},"ApiGatewayErrorResponse":{"type":"object","properties":{"timestamp":{"type":"string"},"error":{"type":"array","items":{"$ref":"#/components/schemas/ErrorCode"}},"message":{"type":"string"},"path":{"type":"string"}},"additionalProperties":false},"ErrorCode":{"type":"object","properties":{"code":{"type":"integer","format":"int32"},"errorMessage":{"type":"string"}},"additionalProperties":false},"EntitlementDetailsV2":{"required":["entitlementId"],"type":"object","properties":{"entitlementId":{"type":"string"},"version":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"slug":{"type":"string"},"offeringKey":{"type":"string"},"optedQuantities":{"type":"array","items":{"$ref":"#/components/schemas/OptedQuantity"}},"featureVariables":{"type":"object","additionalProperties":{"type":"string","description":"feature variables map (nullable field)","nullable":true},"description":"feature variables map (nullable field)","nullable":true},"transactionAccountId":{"type":"string"},"order":{"$ref":"#/components/schemas/Order"},"relatesToEntitlements":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EntitlementRelationship"}},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EntitlementRelationship"}},"createdAt":{"type":"integer","format":"int64"},"updatedAt":{"type":"integer","format":"int64"},"invoiceGroupId":{"type":"string","nullable":true},"entitlementTemplate":{"$ref":"#/components/schemas/EntitlementTemplateV2"},"subscriptionv2":{"$ref":"#/components/schemas/SubscriptionV2WithRestrictedFields"}},"additionalProperties":false},"SubscriptionV2WithRestrictedFields":{"type":"object","properties":{"id":{"type":"string"},"orderItemId":{"type":"string"},"entitlementId":{"type":"string"},"endTimestamp":{"type":"integer","format":"int64"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"trial":{"$ref":"#/components/schemas/Trial"},"billingPeriodDetails":{"$ref":"#/components/schemas/BillingPeriodDetails"},"status":{"type":"string","enum":["PROCESSING","NOT_STARTED","ACTIVE","CANCELLED"]},"startTimestamp":{"type":"integer","format":"int64"},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"testFeatures":{"$ref":"#/components/schemas/TestFeatures"},"chargeDetails":{"$ref":"#/components/schemas/ChargeDetailsRestricted"},"scheduledChanges":{"$ref":"#/components/schemas/SubscriptionScheduleRestricted"},"subscriptionScheduled":{"type":"boolean"},"subscriptionEvergreen":{"type":"boolean"}},"additionalProperties":false},"SubscriptionScheduleV2":{"type":"object","properties":{"nextCycleChange":{"$ref":"#/components/schemas/NextCycleChange"}},"additionalProperties":false},"NextCycleChange":{"type":"object","properties":{"chargeDetails":{"$ref":"#/components/schemas/ChargeDetails"},"changeTimestamp":{"type":"integer","format":"int64"},"enableTrialPeriod":{"type":"boolean"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"orderId":{"type":"string"},"subscriptionScheduleAction":{"type":"string","enum":["UPDATE","CANCEL"]},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"}}},"AccountDetails":{"required":["invoiceGroupId","transactionAccountId"],"type":"object","properties":{"invoiceGroupId":{"type":"string","description":"valid invoiceGroupId"},"transactionAccountId":{"type":"string","description":"valid transactionAccountId"}},"description":"valid account details"},"NextCycleChargeDetails":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}}},"additionalProperties":false},"BillingPeriodDetails":{"type":"object","properties":{"billingAnchorTimestamp":{"type":"integer","format":"int64"},"nextBillingTimestamp":{"type":"integer","format":"int64"}}},"ChargeDetails":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}}}},"SubscriptionInEntitlementDetails":{"required":["chargeQuantities","invoiceGroupId","promotionIds"],"type":"object","properties":{"id":{"type":"string"},"billingAnchorTimestamp":{"type":"integer","format":"int64"},"nextBillingTimestamp":{"type":"integer","format":"int64"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}},"promotionIds":{"type":"array","items":{"type":"string"}},"invoiceGroupId":{"type":"string"},"startTimestamp":{"type":"integer","format":"int64"},"endTimestamp":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["PROCESSING","GENERATED","PAID","UNPAID","ACTIVE","CANCELLED"]},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"scheduledChanges":{"$ref":"#/components/schemas/SubscriptionSchedule"},"trial":{"$ref":"#/components/schemas/Trial"}},"additionalProperties":false,"deprecated":true},"SubscriptionSchedule":{"type":"object","properties":{"subscriptionId":{"type":"string"},"stripeSubscriptionId":{"type":"string"},"orderItemId":{"type":"string"},"orderId":{"type":"string"},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"promotionIds":{"type":"array","items":{"type":"string"}},"startDate":{"type":"integer","format":"int64"},"subscriptionScheduleAction":{"type":"string","enum":["UPDATE","CANCEL"]},"systemOrderId":{"type":"string"},"latestInvoice":{"type":"string"},"trial":{"$ref":"#/components/schemas/Trial"},"skipTrial":{"type":"boolean"},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstance"}},"chargeQuantityList":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"scheduleListPrice":{"type":"integer","format":"int64"},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"}}},"EntitlementRelationshipInDetailsApi":{"type":"object","properties":{"entitlementId":{"type":"string"},"relationshipType":{"type":"string"},"relationshipId":{"type":"string"}},"additionalProperties":false},"Order":{"type":"object","properties":{"id":{"type":"string"},"itemId":{"type":"string"}},"additionalProperties":false},"EntitlementTemplateV2":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"integer","format":"int32"},"data":{"type":"object"}},"additionalProperties":false},"GetQuoteResponseV2":{"required":["createdAt","createdBy","id","invoiceGroupId","lineItems","name","number","reasonCode","revision","status","transactionAccountId","upcomingBillsRequestedAt","version"],"type":"object","properties":{"id":{"type":"string","description":"Id for the quote - this will be in UUID format"},"name":{"type":"string","description":"Name of the quote that customer will specify in UI"},"version":{"type":"integer","description":"The latest version of the quote","format":"int32"},"contractType":{"type":"string","description":"Quote contract type specifying standard or Non-standard quote","enum":["STANDARD","NON_STANDARD"]},"clonedFrom":{"type":"string","description":"The reference quote that current quote was cloned from"},"number":{"type":"string","description":"Human Readable ID for the quote"},"expiresAt":{"type":"integer","description":"The time in epoch time after which the quote will expire","format":"int64"},"expiresAfterDays":{"type":"integer","description":"The number of days after which the quote should expire when it is finalised","format":"int32"},"fromQuote":{"type":"string","description":"The reference quote that current quote was revised from"},"revision":{"type":"integer","description":"The number of times this quote is revised","format":"int32"},"locale":{"type":"string","description":"The language in which quote should be presented to customers on page or pdf. Default value will be en-US"},"transactionAccountId":{"type":"string","description":"The destination Transaction Account for the customer for which quote is created"},"reasonCode":{"type":"string","description":"Reason code stores the information on how the quote arrived at current Status"},"invoiceGroupId":{"type":"string","description":"Invoice group to which the subscription will be associated once quote is finalized"},"status":{"type":"string","description":"Status field signifies what is the current state of a Quote","enum":["VALIDATION_IN_PROGRESS","CREATION_IN_PROGRESS","FINALIZATION_IN_PROGRESS","ACCEPTANCE_IN_PROGRESS","CANCELLATION_IN_PROGRESS","CLONING_IN_PROGRESS","REVISION_IN_PROGRESS","DRAFT","UPDATE_IN_PROGRESS","OPEN","CANCELLED","STALE","ACCEPTED"]},"externalNotes":{"type":"array","description":"External notes that customer can view but can only be edited by CAs","items":{"$ref":"#/components/schemas/NoteDto"}},"createdBy":{"$ref":"#/components/schemas/AuthorContextDto"},"createdAt":{"type":"integer","description":"Timestamp at which this quote was created","format":"int64"},"updatedBy":{"$ref":"#/components/schemas/AuthorContextDto"},"updatedAt":{"type":"integer","description":"Timestamp at which this quote was last updated","format":"int64"},"lineItems":{"type":"array","description":"Individual quote line items which contains unique product, pricing plan, existing subscription information etc","items":{"$ref":"#/components/schemas/LineItemResponse"}},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for the quote"},"description":"Metadata for the quote"},"finalizedAt":{"type":"integer","description":"The current date time in milliseconds when the quote was finalized","format":"int64"},"staleReason":{"$ref":"#/components/schemas/StaleReasonResponse"},"cancelledReason":{"$ref":"#/components/schemas/CanceledReasonResponse"},"upcomingBillsRequestedAt":{"type":"integer","description":" Timestamp at which upcoming bills were requested","format":"int64"},"upcomingBillsComputedAt":{"type":"integer","description":" Timestamp at which upcoming bills were computed","format":"int64"},"upcomingBills":{"$ref":"#/components/schemas/UpcomingBillsResponseV2"},"autoRefresh":{"$ref":"#/components/schemas/AutoRefreshResponse"}},"additionalProperties":false},"OfferingErrorResponse":{"type":"object","properties":{"id":{"type":"string"},"timestamp":{"type":"string","format":"date-time"},"status":{"type":"integer","format":"int32"},"code":{"type":"string"},"title":{"type":"string"},"detail":{"type":"string"},"path":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Result"}}},"additionalProperties":false},"Result":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"},"arguments":{"type":"array","items":{"type":"object"}}},"additionalProperties":false},"PaginatedResponsePrivateProductResponse":{"required":["values"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PrivateProductResponse"}},"nextId":{"type":"string"}},"additionalProperties":false},"PrivateProductResponse":{"required":["ari","id","key","name","status","updatedAt","version"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"ari":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE"]}},"version":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]},"key":{"type":"string"},"chargeElements":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"uncollectibleAction":{"$ref":"#/components/schemas/UncollectibleActionResponse"},"catalogAccountId":{"type":"string"}},"additionalProperties":false},"UncollectibleActionResponse":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["DOWNGRADE","CANCEL"]},"destination":{"$ref":"#/components/schemas/UncollectibleActionDestinationResponse"}},"additionalProperties":false},"UncollectibleActionDestinationResponse":{"required":["offeringKey"],"type":"object","properties":{"offeringKey":{"type":"string"}},"additionalProperties":false},"OfferingV2Response":{"required":["ari","derivedOfferings","hostingType","id","key","name","pricingType","productKey","sku","status","syntheticTemplateKeys","type"],"type":"object","properties":{"id":{"type":"string"},"key":{"type":"string"},"name":{"type":"string"},"ari":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"sku":{"type":"string","description":"Stock keeping unit (SKU)."},"hostingType":{"type":"string","enum":["CLOUD"]},"level":{"type":"integer","description":"The hierarchy level of an offering for offering transitions purposes including upgrades and downgrades within a group of offerings.","format":"int32","nullable":true},"productKey":{"type":"string"},"slugs":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"type":{"type":"string","enum":["PARENT","CHILD"]},"offeringGroup":{"$ref":"#/components/schemas/OfferingGroupResponse"},"pricingType":{"type":"string","enum":["EXTERNAL","FREE","LIMITED_FREE","PAID"]},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE"]}},"version":{"type":"integer","format":"int64"},"chargeElements":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ChargeElementData"},"description":"Ceiling for every charge element present in offering product."},"syntheticTemplateKeys":{"uniqueItems":true,"type":"array","description":"Keys to synthetic templates that can be used to create synthetic offerings.","items":{"type":"string","description":"Keys to synthetic templates that can be used to create synthetic offerings."}},"derivedOfferings":{"uniqueItems":true,"type":"array","description":"Synthetic offerings created using this offering and its synthetic templates.","items":{"$ref":"#/components/schemas/DerivedOffering"}},"expiryDate":{"type":"integer","format":"int64"},"derivedFromOffering":{"$ref":"#/components/schemas/DerivedFromOffering"},"catalogAccountId":{"type":"string"},"allowReactivationOnDifferentOffering":{"type":"boolean"},"relationshipRequirements":{"uniqueItems":true,"type":"array","description":"Set of relationship requirements which this offering allows or requires.","items":{"$ref":"#/components/schemas/RelationshipRequirementResponse"}},"dependsOnOfferings":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"trial":{"$ref":"#/components/schemas/TrialResponse"},"entitlementTemplateId":{"type":"string"}},"additionalProperties":false},"TrialResponse":{"required":["lengthDays"],"type":"object","properties":{"lengthDays":{"type":"integer","format":"int32"}},"additionalProperties":false,"nullable":true},"RelationshipRequirementResponse":{"type":"object","properties":{"type":{"type":"string","enum":["APP_DEPENDENCE","ADDON_DEPENDENCE","APP_COMPATIBILITY","FAMILY_CONTAINER","SANDBOX_DEPENDENCE","SANDBOX_GRANT","ENTERPRISE","MULTI_INSTANCE","ENTERPRISE_SANDBOX_GRANT","COLLECTION","COLLECTION_TRIAL"]},"side":{"type":"string","enum":["FROM","TO"]},"level":{"type":"string","enum":["ALLOWED","REQUIRED"]}},"additionalProperties":false,"description":"Set of relationship requirements which this offering allows/requires"},"DerivedFromOffering":{"type":"object","properties":{"templateId":{"type":"string"},"templateVersion":{"type":"integer","format":"int64"},"originalOfferingKey":{"type":"string"}},"additionalProperties":false,"description":"The original offering used to generate this synthetic offering. If this field is not null, then this is a synthetic offering."},"DerivedOffering":{"type":"object","properties":{"templateId":{"type":"string"},"templateVersion":{"type":"integer","format":"int64"},"generatedOfferingKey":{"type":"string"}},"additionalProperties":false,"description":"Synthetic offerings created using this offering and its synthetic templates."},"ChargeElementData":{"required":["ceiling","overrides"],"type":"object","properties":{"ceiling":{"minimum":0,"type":"integer","format":"int32"},"overrides":{"$ref":"#/components/schemas/ChargeElementOverrides"}},"additionalProperties":false,"description":"Set the ceiling for every charge element present in offering product"},"ChargeElementOverrides":{"required":["allow"],"type":"object","properties":{"allow":{"type":"boolean"}},"additionalProperties":false},"OfferingGroupResponse":{"required":["key","name","productKey","slug"],"type":"object","properties":{"key":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"level":{"type":"integer","description":"The hierarchy level of an offering group for offering transitions purposes.","format":"int32","nullable":true},"productKey":{"type":"string"},"catalogAccountId":{"type":"string"}},"additionalProperties":false,"nullable":true},"PricingPlanResponse":{"required":["ari","currency","description","id","items","key","offeringKey","offeringName","primaryCycle","productKey","sku","status","type"],"type":"object","properties":{"key":{"type":"string"},"id":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"sku":{"type":"string","description":"Stock keeping unit (SKU)."},"description":{"type":"string"},"offeringKey":{"type":"string"},"productKey":{"type":"string"},"offeringName":{"type":"string"},"ari":{"type":"string"},"primaryCycle":{"$ref":"#/components/schemas/CycleResponse"},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]},"originalPricingPlanKey":{"type":"string","description":"Original pricing plan key.","deprecated":true},"currency":{"type":"string","enum":["USD","JPY"]},"type":{"type":"string"},"maxNewQuoteDate":{"type":"integer","format":"int64"},"activatedWithReason":{"type":"string","enum":["DEFAULT_PRICING","ADVANTAGE_PRICING","EXPERIMENTAL_PRICING"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/PricingPlanItemResponse"}},"version":{"type":"integer","format":"int64"},"relationships":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PricingPlanRelationshipResponse"}},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE"]}},"catalogAccountId":{"type":"string"},"activationDate":{"type":"integer","format":"int64"}},"additionalProperties":false},"PricingPlanRelationshipResponse":{"type":"object","properties":{"fromPricingPlanKey":{"type":"string"},"toPricingPlanKey":{"type":"string"},"type":{"type":"string","enum":["ADVANTAGE_PRICING","NEXT_PRICING","SYNTHETIC_GENERATED","CURRENCY_GENERATED"]},"metadata":{"type":"object","additionalProperties":{"type":"object"}}},"additionalProperties":false},"PricingPlanItemResponse":{"required":["chargeElement","chargeType","cycle","tiers","tiersMode"],"type":"object","properties":{"cycle":{"$ref":"#/components/schemas/CycleResponse"},"chargeType":{"type":"string","enum":["METERED","LICENSED","AUTO_SCALING"]},"chargeElement":{"type":"string"},"tiersMode":{"type":"string","enum":["GRADUATED","VOLUME"]},"usageUpdateCadence":{"$ref":"#/components/schemas/UsageUpdateCadenceResponse"},"prorateOnUsageChange":{"type":"string","enum":["CREATE_PRORATIONS","NONE","ALWAYS_INVOICE"]},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/PricingPlanTierResponse"}}},"additionalProperties":false},"PricingPlanTierResponse":{"required":["amount","floor","policy"],"type":"object","properties":{"amount":{"type":"integer","format":"int64","deprecated":true},"policy":{"type":"string","deprecated":true,"enum":["BLOCK","PER_UNIT"]},"floor":{"type":"integer","format":"int64"},"ceiling":{"type":"integer","format":"int64"},"unitAmount":{"type":"integer","description":"Unit amount represents the charge per unit.","format":"int64","nullable":true},"flatAmount":{"type":"integer","description":"Flat amount represents the charge for the block.","format":"int64","nullable":true}},"additionalProperties":false},"UsageUpdateCadenceResponse":{"required":["cadenceIntervalMinutes","name"],"type":"object","properties":{"name":{"type":"string"},"cadenceIntervalMinutes":{"type":"integer","format":"int32"}},"additionalProperties":false},"CycleResponse":{"required":["interval","name"],"type":"object","properties":{"name":{"type":"string"},"interval":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"]},"count":{"type":"integer","format":"int32"}},"additionalProperties":false},"InvoiceGroupPrivateDto":{"required":["createdAt","currency","id","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"name":{"type":"string","description":"An identifier to help customers/partners organize invoices.","nullable":true},"currency":{"type":"string","enum":["USD"]},"billToParty":{"$ref":"#/components/schemas/BillToPartyDto"},"defaultPaymentMethod":{"type":"string","description":"If not specified, will use the transaction account payment method.","nullable":true},"purchaseOrder":{"$ref":"#/components/schemas/PurchaseOrder"},"memo":{"type":"string","nullable":true},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"recipients":{"type":"array","items":{"type":"string"}},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"shipToParty":{"$ref":"#/components/schemas/ShipToPartyPrivateDto"}},"additionalProperties":false},"ShipToPartyPrivateDto":{"required":["id","name","postalAddress","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"}},"additionalProperties":false},"OrderGetResponseDtoV2":{"type":"object","properties":{"orderId":{"type":"string"},"slug":{"type":"string"},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemGetResponseDtoV2"}},"additionalTriggeredOrders":{"type":"array","items":{"$ref":"#/components/schemas/OrderGetResponseDtoV2"}},"createdDate":{"type":"integer","format":"int64"}}},"OrderItemGetResponseDtoV2":{"type":"object","properties":{"offeringId":{"type":"string"},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"orderItemId":{"type":"string"},"optedUsageOptions":{"$ref":"#/components/schemas/GetOrderItemOptedUsageOptionDtoV2"},"type":{"type":"string","enum":["CREATION_ORDER","AMENDMENT_ORDER","PATCH_ENTITLEMENT_DETAILS_ORDER","CANCELLATION_ORDER","SYSTEM_CANCELLATION_ORDER","SYSTEM_AMENDMENT_ORDER","REACTIVATION_ORDER","ACCOUNT_MODIFICATION_ORDER","REWIND_ORDER","REVERT_TRIAL_ORDER","REBILL_ORDER","TRANSITION_ORDER","TRANSFER_IN_ORDER","TRANSFER_IN_CREATE_ORDER","TRANSFER_OUT_ORDER","SYSTEM_PATCH_ENTITLEMENT_DETAILS_ORDER"]},"processingInfo":{"$ref":"#/components/schemas/ProcessingInfoV2"},"billingOptions":{"$ref":"#/components/schemas/BillingOptionsDto"},"resetOptions":{"$ref":"#/components/schemas/ResetOptionsDto"},"reasonCode":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"triggeredByOrderItem":{"$ref":"#/components/schemas/OrderItemRefDto"},"promotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"isImmediate":{"type":"boolean"},"originalOrderItemId":{"type":"string"},"quoteLineItemDetailsReference":{"$ref":"#/components/schemas/QuoteLineItemDetailsReferenceDto"},"subscriptionStartTime":{"type":"integer","format":"int64"},"transition":{"$ref":"#/components/schemas/TransitionDto"},"rewindToOrderItemId":{"type":"string"},"billingAnchorTime":{"type":"integer","format":"int64"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64"},"backdateTimestamp":{"type":"integer","format":"int64"},"rebillOptions":{"$ref":"#/components/schemas/RebillOptionsDto"},"prorationBehaviour":{"type":"string","enum":["NONE","ALWAYS_INVOICE"]},"relatesFromEntitlements":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/RelatesFromEntitlementResponseDto"},{"$ref":"#/components/schemas/RelatesFromOrderItemResponseDto"}]}}}},"OmsPromotionDtoV2":{"type":"object","properties":{"promotionInstanceId":{"type":"string","nullable":true},"promotionDefinition":{"$ref":"#/components/schemas/PromotionDefinitionDtoV2"}},"nullable":true},"PromotionDefinitionDtoV2":{"type":"object","properties":{"promotionId":{"type":"string","format":"uuid","nullable":true},"promotionCode":{"type":"string","nullable":true},"customisedValues":{"$ref":"#/components/schemas/CustomPromotionValueDtoV2"}},"nullable":true},"CustomPromotionValueDtoV2":{"required":["benefits"],"type":"object","properties":{"benefits":{"type":"array","items":{"$ref":"#/components/schemas/PromotionBenefitDto"}}},"nullable":true},"ProcessingInfoV2":{"type":"object","properties":{"status":{"type":"string","enum":["PROCESSING","SUCCESS","FAIL"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"transitionTimestamp":{"type":"integer","format":"int64"},"transitionTime":{"type":"string","enum":["IMMEDIATE","NEXT_CYCLE","SCHEDULED"]},"saleTransitionDetails":{"$ref":"#/components/schemas/SaleTransitionDetailsDto"},"saleTransitionType":{"type":"string","enum":["NEW","NA","DOWNGRADE","UPGRADE","RENEW"]},"computedDetails":{"$ref":"#/components/schemas/ComputedDetailsV2"},"accountModification":{"$ref":"#/components/schemas/AccountModificationDto"},"additionalTriggeredOrderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemRefDto"}},"prorationBehaviour":{"type":"string","enum":["NONE","ALWAYS_INVOICE","CREATE_PRORATIONS"]},"impactedEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/ImpactedEntitlementDto"}}}},"ComputedDetailsV2":{"type":"object","properties":{"computedEndTimestamp":{"type":"integer","format":"int64"},"offeringId":{"type":"string"},"usageOptions":{"$ref":"#/components/schemas/GetOrderItemOptedUsageOptionDtoV2"},"computedBillUntilTimestamp":{"type":"integer","format":"int64"},"orderedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"removedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"pricingPlanTransition":{"$ref":"#/components/schemas/PricingPlanTransitionDto"},"replacedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"scheduledChanges":{"$ref":"#/components/schemas/ComputedScheduledChangesDto"}}},"GetOrderItemOptedUsageOptionDtoV2":{"type":"object","properties":{"chargingDetails":{"$ref":"#/components/schemas/ChargingDetailsDto"},"trial":{"$ref":"#/components/schemas/TrialIntentDto"},"billingBehaviour":{"$ref":"#/components/schemas/BillingBehaviourDto"},"effectiveTime":{"$ref":"#/components/schemas/EffectiveTimeDto"}}},"OptedUsageOptionDtoV2":{"type":"object","properties":{"trial":{"$ref":"#/components/schemas/TrialIntentDtoV2"},"chargingDetails":{"$ref":"#/components/schemas/ChargingDetailsDtoV2"},"effectiveTime":{"$ref":"#/components/schemas/EffectiveTimeDtoV2"}},"nullable":true},"OrderResponseDto":{"type":"object","properties":{"orderId":{"type":"string"},"slug":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemResponseDto"}},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"additionalTriggeredOrders":{"type":"array","items":{"$ref":"#/components/schemas/OrderResponseDto"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"OrderItemResponseDto":{"required":["itemId","orderItemId"],"type":"object","properties":{"itemId":{"type":"string"},"orderItemId":{"type":"string"},"transactionAccountId":{"type":"string"},"invoiceGroupId":{"type":"string"},"triggeredByOrderItem":{"$ref":"#/components/schemas/OrderItemRefDto"},"processingInfo":{"$ref":"#/components/schemas/ProcessingInfoResponseDto"},"metadata":{"type":"object","additionalProperties":{"type":"string"}}}},"ProcessingInfoResponseDto":{"type":"object","properties":{"additionalTriggeredOrderItems":{"type":"array","items":{"$ref":"#/components/schemas/OrderItemRefDto"}},"computedDetails":{"$ref":"#/components/schemas/OrderedPromotionComputedDetails"},"saleTransitionDetails":{"$ref":"#/components/schemas/SaleTransitionDetailsDto"}}},"OrderedPromotionComputedDetails":{"type":"object","properties":{"orderedPromotions":{"type":"array","items":{"$ref":"#/components/schemas/OmsPromotionDto"}}}},"OrderWithQuotesWebRequestDtoV2":{"required":["orderId","quote"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderWebRequestDtoV2"},{"type":"object","properties":{"quote":{"$ref":"#/components/schemas/QuoteReferenceWebDto"}}}]},"OrderWebRequestDtoV2":{"required":["orderId","source"],"type":"object","properties":{"orderId":{"type":"string","format":"uuid"},"transactionAccountId":{"type":"string","format":"uuid","nullable":true},"metadata":{"maxProperties":15,"type":"object","additionalProperties":{"maxProperties":15,"type":"string"}},"source":{"type":"string"}},"discriminator":{"propertyName":"source","mapping":{"ORDER_ITEMS":"#/components/schemas/OrderRequestDtoV2","QUOTE":"#/components/schemas/OrderWithQuotesWebRequestDtoV2"}}},"OrderRequestDtoV2":{"required":["orderId"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderWebRequestDtoV2"},{"type":"object","properties":{"invoiceGroupId":{"type":"string","format":"uuid","nullable":true},"items":{"maxItems":24,"minItems":1,"uniqueItems":true,"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/OrderCreationItemDtoV2"},{"$ref":"#/components/schemas/OrderCancellationItemDtoV2"},{"$ref":"#/components/schemas/OrderAmendmentItemDtoV2"},{"$ref":"#/components/schemas/OrderReactivationItemDtoV2"},{"$ref":"#/components/schemas/OrderAccountModificationItemDtoV2"},{"$ref":"#/components/schemas/OrderRevertTrialItemDtoV2"},{"$ref":"#/components/schemas/OrderTransitionItemDtoV2"}]}},"orderIntentId":{"type":"string","format":"uuid","nullable":true}}}]},"OrderTransitionItemDtoV2":{"required":["entitlement","itemId","transition","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["TRANSITION_ORDER"]},"entitlement":{"$ref":"#/components/schemas/TransitionOrderEntitlementRefDto"},"transition":{"$ref":"#/components/schemas/TransitionDto"},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"}}}]},"TestParametersDto":{"type":"object","properties":{"billingClockId":{"type":"string","nullable":true},"allowExpiredPricingPlan":{"type":"boolean","nullable":true},"overrideUsage":{"type":"object","additionalProperties":{"type":"integer","format":"int64","nullable":true},"nullable":true}},"nullable":true},"TransitionOrderEntitlementRefDto":{"required":["id"],"type":"object","properties":{"id":{"type":"string","format":"uuid"}}},"OrderItemRequestDtoV2":{"required":["itemId","type"],"type":"object","properties":{"itemId":{"type":"string"},"type":{"type":"string","enum":["CREATION_ORDER","AMENDMENT_ORDER","CANCELLATION_ORDER","REACTIVATION_ORDER","ACCOUNT_MODIFICATION_ORDER","REVERT_TRIAL_ORDER","TRANSITION_ORDER"]},"optedUsageOptions":{"$ref":"#/components/schemas/OptedUsageOptionDtoV2"},"metadata":{"maxProperties":15,"type":"object","additionalProperties":{"maxProperties":15,"type":"string","nullable":true},"nullable":true}},"discriminator":{"propertyName":"type","mapping":{"CREATION_ORDER":"#/components/schemas/OrderCreationItemDtoV2","CANCELLATION_ORDER":"#/components/schemas/OrderCancellationItemDtoV2","AMENDMENT_ORDER":"#/components/schemas/OrderAmendmentItemDtoV2","REACTIVATION_ORDER":"#/components/schemas/OrderReactivationItemDtoV2","ACCOUNT_MODIFICATION_ORDER":"#/components/schemas/OrderAccountModificationItemDtoV2","REVERT_TRIAL_ORDER":"#/components/schemas/OrderRevertTrialItemDtoV2","TRANSITION_ORDER":"#/components/schemas/OrderTransitionItemDtoV2"}}},"EffectiveTimeDtoV2":{"required":["endsAt"],"type":"object","properties":{"endsAt":{"$ref":"#/components/schemas/EndsAtEffectiveTimeDtoV2"},"startsAt":{"$ref":"#/components/schemas/StartsAtEffectiveTimeDtoV2"}},"nullable":true},"StartsAtEffectiveTimeDtoV2":{"required":["type"],"type":"object","properties":{"timestamp":{"type":"integer","format":"int64","nullable":true},"type":{"type":"string","enum":["TIMESTAMP"]}},"nullable":true},"EndsAtEffectiveTimeDtoV2":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["TIMESTAMP","DURATION"]},"billingFrequencyCount":{"type":"integer","format":"int32","nullable":true},"endTimestamp":{"type":"integer","format":"int64","nullable":true}}},"ChargingDetailsDtoV2":{"type":"object","properties":{"pricingPlanId":{"type":"string","description":"Blank/Empty String will be treated as null","format":"uuid","nullable":true},"chargeQuantities":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/ChargeQuantityDto"}}},"nullable":true},"TrialIntentDtoV2":{"type":"object","properties":{"skipTrial":{"type":"boolean","nullable":true},"offeringId":{"type":"string","format":"uuid","nullable":true},"pricingPlanId":{"type":"string","format":"uuid","nullable":true},"startTimestamp":{"type":"integer","format":"int64","nullable":true},"endTimestamp":{"type":"integer","format":"int64","nullable":true},"behaviourAtEndOfTrial":{"type":"string","nullable":true,"enum":["CONVERT_TO_PAID","CANCEL","REVERT_TRIAL"]}},"nullable":true},"OrderRevertTrialItemDtoV2":{"required":["entitlement","itemId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["REVERT_TRIAL_ORDER"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"}}}]},"OrderAccountModificationItemDtoV2":{"required":["accountModification","entitlement","itemId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["ACCOUNT_MODIFICATION_ORDER"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"accountModification":{"$ref":"#/components/schemas/AccountModificationDto"},"isImmediate":{"type":"boolean","nullable":true},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"}}}]},"OrderReactivationItemDtoV2":{"required":["entitlement","itemId","offeringId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["REACTIVATION_ORDER"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"offeringId":{"type":"string","format":"uuid"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64","nullable":true},"promotions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RelatesFromOrderItemDto"},{"$ref":"#/components/schemas/RelatesFromEntitlementDto"}]}}}}]},"RelatesFromEntitlementDto":{"required":["entitlementId","referenceType","relationshipType"],"type":"object","allOf":[{"$ref":"#/components/schemas/RelatesFromDto"},{"type":"object","properties":{"entitlementId":{"type":"string","nullable":true}}}]},"RelatesFromDto":{"required":["referenceType","relationshipType"],"type":"object","properties":{"relationshipType":{"type":"string"},"referenceType":{"type":"string","enum":["ORDER_ITEM","ENTITLEMENT"]}},"nullable":true,"discriminator":{"propertyName":"referenceType","mapping":{"ORDER_ITEM":"#/components/schemas/RelatesFromOrderItemDto","ENTITLEMENT":"#/components/schemas/RelatesFromEntitlementDto"}}},"RelatesFromOrderItemDto":{"required":["itemId","referenceType","relationshipType"],"type":"object","allOf":[{"$ref":"#/components/schemas/RelatesFromDto"},{"type":"object","properties":{"itemId":{"type":"string","nullable":true}}}]},"OrderAmendmentItemDtoV2":{"required":["entitlement","itemId","offeringId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["AMENDMENT_ORDER"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"offeringId":{"type":"string","format":"uuid"},"isImmediate":{"type":"boolean","nullable":true},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64","nullable":true},"promotions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"billingOptions":{"$ref":"#/components/schemas/BillingOptionsDto"},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RelatesFromOrderItemDto"},{"$ref":"#/components/schemas/RelatesFromEntitlementDto"}]}}}}]},"OrderCancellationItemDtoV2":{"required":["entitlement","itemId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["CANCELLATION_ORDER"]},"entitlement":{"$ref":"#/components/schemas/OrderEntitlementRefDto"},"isImmediate":{"type":"boolean","nullable":true},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"}}}]},"OrderCreationItemDtoV2":{"required":["itemId","offeringId","type"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderItemRequestDtoV2"},{"type":"object","properties":{"type":{"type":"string","enum":["CREATION_ORDER"]},"offeringId":{"type":"string","format":"uuid"},"testParameters":{"$ref":"#/components/schemas/TestParametersDto"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64","nullable":true},"billingOptions":{"$ref":"#/components/schemas/BillingOptionsDto"},"promotions":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/OmsPromotionDtoV2"}},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"oneOf":[{"$ref":"#/components/schemas/RelatesFromOrderItemDto"},{"$ref":"#/components/schemas/RelatesFromEntitlementDto"}]}}}}]},"PagedListInvoicePrivateDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePrivateDto"}},"lastEvaluatedKey":{"type":"string","description":"Use the `lastEvaluatedKey` in your next `pageRequest` to continue paging from where the `PagedList` ended. If there weren't enough records left to fill up the `PagedList`, the value of `lastEvaluatedKey` will be null, so you won't have to continue paging.","nullable":true}},"additionalProperties":false},"InvoicePrivateDto":{"required":["id","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"number":{"type":"string"},"invoiceGroup":{"type":"string"},"memo":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","OPEN","PAID","DEFERRED_PAID","PAYMENT_DEFERRED","UNCOLLECTIBLE","VOID"]},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"finalizedAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"dueAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"paidAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"uncollectibleAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64","nullable":true},"billTo":{"$ref":"#/components/schemas/BillToParty"},"paymentMethod":{"type":"string","description":"if not specified, it will use the payment method from invoice group","nullable":true},"currency":{"type":"string","enum":["USD"]},"subtotal":{"type":"number"},"total":{"type":"number"},"tax":{"type":"number"},"taxIdLabel":{"type":"string"},"headerTaxId":{"type":"string"},"headerTaxIds":{"type":"array","items":{"$ref":"#/components/schemas/HeaderTaxId"}},"additionalNotes":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"dunningHistory":{"type":"array","items":{"$ref":"#/components/schemas/DunningStatus"}},"dunningStatus":{"$ref":"#/components/schemas/DunningStatus"},"purchaseOrderNumber":{"type":"string"},"appliedBalance":{"type":"number","description":"The customer balance applied on this invoice. If negative, the invoice total was reduced by this amount. If positive, the amount due was increased by this amount."},"reInvoiced":{"type":"boolean","nullable":true},"prePaymentCreditNotesAmount":{"type":"number","description":"The total amount of all pre-payment credit notes issued for this invoice."},"userDefinedNotes":{"type":"object","additionalProperties":{"type":"string"}},"paymentStatus":{"$ref":"#/components/schemas/PaymentStatus"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"shipTo":{"$ref":"#/components/schemas/ToPartyPrivateDto"},"paymentMethodObj":{"oneOf":[{"$ref":"#/components/schemas/CreditCard"},{"$ref":"#/components/schemas/Deferred"},{"$ref":"#/components/schemas/PayPal"}]}},"additionalProperties":false},"PaymentMethodPrivateDto":{"required":["createdAt","currency","default","id","type","updatedAt"],"type":"object","properties":{"currency":{"type":"string","description":"We currently only support USD","example":"USD","enum":["USD","JPY"]},"default":{"type":"boolean","description":"Deferred type is not allowed as default"},"createdAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"updatedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"type":{"type":"string","description":"Payment types would be either CreditCard or Deferred or PayPal","example":"CARD","enum":["CARD","DEFERRED","PAYPAL"]},"id":{"type":"string"},"transactionAccount":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"}},"discriminator":{"propertyName":"type","mapping":{"CARD":"#/components/schemas/CreditCard","DEFERRED":"#/components/schemas/Deferred","PAYPAL":"#/components/schemas/PayPal"}}},"ToPartyPrivateDto":{"required":["name","postalAddress"],"type":"object","properties":{"id":{"type":"string","nullable":true},"version":{"type":"integer","format":"int64","nullable":true},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in epoch milliseconds.","format":"int64"},"transactionAccountPartition":{"$ref":"#/components/schemas/TransactionAccountPartitionDto"}},"additionalProperties":false},"InvoiceGroupPublicDto":{"required":["createdAt","currency","id","updatedAt","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"name":{"type":"string","description":"An identifier that would help customers/partners segregate invoices.","nullable":true},"slug":{"type":"string","description":"Human readable identifier for Invoice Group in `IG-xxxx-xxxx-xxxx` format where x=alphanumeric character","nullable":true},"currency":{"type":"string","enum":["USD","JPY"]},"shipToParty":{"$ref":"#/components/schemas/ShipToPartyPublicDto"},"billToParty":{"$ref":"#/components/schemas/BillToPartyDto"},"defaultPaymentMethod":{"type":"string","description":"if not specified it will use the transaction account payment method","nullable":true},"purchaseOrder":{"$ref":"#/components/schemas/PurchaseOrder"},"active":{"type":"boolean","nullable":true},"memo":{"type":"string","nullable":true},"createdAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"updatedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"recipients":{"type":"array","items":{"type":"string"}}},"additionalProperties":false},"ShipToPartyPublicDto":{"required":["id","name","postalAddress","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"updatedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"}},"additionalProperties":false,"nullable":true},"PagedListInvoicePublicDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePublicDto"}},"lastEvaluatedKey":{"type":"string","description":"Use the lastEvaluatedKey in your next pageRequest to continue paging from where the PagedList finished. If there weren't enough records left to search in order to fill up the PagedList completely, the value of lastEvaluatedKey will be null, therefore you dont have to continue paging.","nullable":true}},"additionalProperties":false},"InvoicePublicDto":{"required":["createdAt","id","updatedAt","version"],"type":"object","properties":{"id":{"type":"string"},"version":{"type":"integer","format":"int64"},"number":{"type":"string"},"invoiceGroup":{"type":"string"},"memo":{"type":"string","nullable":true},"status":{"type":"string","enum":["DRAFT","OPEN","PAID","DEFERRED_PAID","PAYMENT_DEFERRED","UNCOLLECTIBLE","VOID"]},"createdAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"updatedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"finalizedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64","nullable":true},"dueAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"paidAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64","nullable":true},"uncollectibleAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64","nullable":true},"billTo":{"$ref":"#/components/schemas/BillToParty"},"shipTo":{"$ref":"#/components/schemas/ToPartyPublicDto"},"paymentMethod":{"type":"string","description":"if not specified, it will use the payment method from invoice group","nullable":true},"paymentMethodObj":{"oneOf":[{"$ref":"#/components/schemas/CreditCard"},{"$ref":"#/components/schemas/Deferred"},{"$ref":"#/components/schemas/PayPal"}]},"currency":{"type":"string","enum":["USD","JPY"]},"subtotal":{"type":"number"},"total":{"type":"number"},"tax":{"type":"number"},"taxIdLabel":{"type":"string"},"headerTaxId":{"type":"string"},"headerTaxIds":{"type":"array","items":{"$ref":"#/components/schemas/HeaderTaxId"}},"additionalNotes":{"type":"string"},"items":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceItem"}},"dunningHistory":{"type":"array","items":{"$ref":"#/components/schemas/DunningStatus"}},"dunningStatus":{"$ref":"#/components/schemas/DunningStatus"},"purchaseOrderNumber":{"type":"string"},"appliedBalance":{"type":"number","description":"The customer balance applied on this invoice. If negative, the invoice total was reduced by this amount. If positive, the amount due was increased by this amount."},"reInvoiced":{"type":"boolean","nullable":true},"prePaymentCreditNotesAmount":{"type":"number","description":"The total amount of all pre-payment credit notes issued for this invoice."},"userDefinedNotes":{"type":"object","additionalProperties":{"type":"string"}},"paymentStatus":{"$ref":"#/components/schemas/PaymentStatus"}},"additionalProperties":false},"ToPartyPublicDto":{"required":["name","postalAddress"],"type":"object","properties":{"id":{"type":"string","nullable":true},"version":{"type":"integer","format":"int64","nullable":true},"name":{"type":"string"},"postalAddress":{"$ref":"#/components/schemas/PostalAddress"},"priceEligibility":{"type":"object","additionalProperties":{"type":"boolean"}},"taxId":{"type":"string"},"taxIds":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"createdAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"updatedAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"}},"additionalProperties":false},"PaginatedResponsePublicProductResponse":{"required":["values"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PublicProductResponse"}},"nextId":{"type":"string"}},"additionalProperties":false},"PublicProductResponse":{"required":["ari","id","name","status","updatedAt","version"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"ari":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE","BACK_OFFICE"]}},"version":{"type":"integer","format":"int64"},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]}},"additionalProperties":false},"PublicPricingPlanResponse":{"required":["ari","currency","description","id","items","offeringId","offeringName","primaryCycle","productId","status","type"],"type":"object","properties":{"id":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"description":{"type":"string"},"offeringId":{"type":"string"},"productId":{"type":"string"},"offeringName":{"type":"string"},"ari":{"type":"string"},"primaryCycle":{"$ref":"#/components/schemas/CycleResponseDto"},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]},"currency":{"type":"string","enum":["USD","JPY"]},"type":{"type":"string"},"maxNewQuoteDate":{"type":"integer","format":"int64"},"activatedWithReason":{"type":"string","enum":["DEFAULT_PRICING","ADVANTAGE_PRICING","EXPERIMENTAL_PRICING"]},"items":{"type":"array","items":{"$ref":"#/components/schemas/PublicPricingPlanItemResponse"}},"version":{"type":"integer","format":"int64"},"relationships":{"uniqueItems":true,"type":"array","items":{"$ref":"#/components/schemas/PricingPlanRelationshipResponse"}},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE","BACK_OFFICE"]}},"activationDate":{"type":"integer","format":"int64"},"createdBy":{"type":"string"}},"additionalProperties":false},"PublicPricingPlanItemResponse":{"required":["chargeElement","chargeType","cycle","tiers","tiersMode"],"type":"object","properties":{"cycle":{"$ref":"#/components/schemas/CycleResponseDto"},"chargeType":{"type":"string","enum":["METERED","LICENSED","AUTO_SCALING"]},"chargeElement":{"type":"string"},"tiersMode":{"type":"string","enum":["GRADUATED","VOLUME"]},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/PublicPricingPlanTierResponse"}},"prorateOnUsageChange":{"type":"string","enum":["CREATE_PRORATIONS","NONE","ALWAYS_INVOICE"]}},"additionalProperties":false},"PublicPricingPlanTierResponse":{"required":["floor"],"type":"object","properties":{"floor":{"type":"integer","format":"int64"},"ceiling":{"type":"integer","format":"int64"},"unitAmount":{"type":"integer","description":"Unit amount represents the charge per unit","format":"int64","nullable":true},"flatAmount":{"type":"integer","description":"Flat amount represents the charge for the block","format":"int64","nullable":true}},"additionalProperties":false},"PublicOfferingResponse":{"required":["ari","hostingType","id","name","pricingType","productId","status"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"ari":{"type":"string"},"updatedAt":{"type":"integer","format":"int64"},"hostingType":{"type":"string","enum":["CLOUD","DATACENTER","SERVER"]},"level":{"type":"integer","description":"The hierarchy level of an offering for offering transitions purposes including upgrades and downgrades within a group of offerings.","format":"int32","nullable":true},"productId":{"type":"string"},"slugs":{"uniqueItems":true,"type":"array","items":{"type":"string"}},"pricingType":{"type":"string","enum":["EXTERNAL","FREE","LIMITED_FREE","PAID"]},"status":{"type":"string","enum":["DRAFT","ACTIVE","AT_NOTICE","EXPIRED"]},"supportedBillingSystems":{"uniqueItems":true,"type":"array","items":{"type":"string","enum":["HAMS","CCP","OPSGENIE","BACK_OFFICE"]}},"version":{"type":"integer","format":"int64"},"chargeElements":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/ChargeElementData"},"description":"Set the ceiling for every charge element present in offering product"},"expiryDate":{"type":"integer","format":"int64"},"trial":{"$ref":"#/components/schemas/TrialResponse"},"offeringGroup":{"$ref":"#/components/schemas/PublicOfferingGroupResponse"},"relationshipRequirements":{"uniqueItems":true,"type":"array","description":"Set of relationship requirements which this offering allows/requires","items":{"$ref":"#/components/schemas/RelationshipRequirementResponse"}}},"additionalProperties":false},"PublicOfferingGroupResponse":{"required":["id","name","productId","slug"],"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"level":{"type":"integer","description":"The hierarchy level of an offering group for offering transitions purposes","format":"int32","nullable":true},"productId":{"type":"string"}},"additionalProperties":false},"PaginatedResponsePublicOfferingResponse":{"required":["values"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PublicOfferingResponse"}},"nextId":{"type":"string"}},"additionalProperties":false},"PaginatedResponsePublicPricingPlanResponse":{"required":["values"],"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/PublicPricingPlanResponse"}},"nextId":{"type":"string"}},"additionalProperties":false},"PromotionErrorResponse":{"type":"object","properties":{"title":{"type":"string"},"code":{"type":"string"},"detail":{"type":"string"},"id":{"type":"string"},"status":{"type":"string"}},"additionalProperties":false},"GetPublicPromotionTypeIgnoreRuleResponse":{"type":"object","properties":{"productIds":{"type":"array","description":"List of productIds that have ignored the requested promotion type","items":{"type":"string","description":"List of productIds that have ignored the requested promotion type"}}},"additionalProperties":false},"PublicProductIgnoreRuleResponse":{"type":"object","properties":{"ignored":{"type":"boolean","description":"Flag which indicates if the product is ignored"}},"additionalProperties":false},"EntitlementErrorResponse":{"type":"object","properties":{"timestamp":{"type":"string"},"status":{"type":"integer","format":"int32"},"error":{"type":"string"},"message":{"type":"string"},"path":{"type":"string"},"code":{"type":"string"},"requests":{"type":"array","items":{"type":"object"}}},"additionalProperties":false},"DisplayInfoResponse":{"type":"object","properties":{"entitlementId":{"type":"string","description":"valid entitlement id"},"provisionedResource":{"$ref":"#/components/schemas/ProvisionedResourceDto"}},"additionalProperties":false},"PagedListV2InvoicePublicDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePublicDto"}},"nextId":{"type":"string","description":"Use the nextId in your next pageRequest to continue paging from where the PagedList finished. If there weren't enough records left to search in order to fill up the PagedList completely, the value of nextId will be null, therefore you dont have to continue paging.","nullable":true}},"additionalProperties":false},"ProvisionedResourceDto":{"type":"object","properties":{"ari":{"type":"string","description":"ARI of provisioned resource of an entitlement"},"name":{"type":"string","description":"display name of provisioned resource of an entitlement"}},"additionalProperties":false,"description":"valid provisionedResource or null","nullable":true},"StripeResponse":{"type":"object"},"JsonObject":{"type":"object","properties":{"empty":{"type":"boolean"},"asInt":{"type":"integer","format":"int32"},"asDouble":{"type":"number","format":"double"},"asLong":{"type":"integer","format":"int64"},"asBoolean":{"type":"boolean"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asString":{"type":"string"},"jsonArray":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"},"jsonNull":{"type":"boolean"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asNumber":{"type":"number"},"asFloat":{"type":"number","format":"float"},"asByte":{"type":"string","format":"byte"},"asCharacter":{"type":"string","deprecated":true},"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asShort":{"type":"integer","format":"int32"}}},"JsonNull":{"type":"object","properties":{"asInt":{"type":"integer","format":"int32"},"asDouble":{"type":"number","format":"double"},"asLong":{"type":"integer","format":"int64"},"asBoolean":{"type":"boolean"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"asString":{"type":"string"},"jsonArray":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"},"jsonNull":{"type":"boolean"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"},"asNumber":{"type":"number"},"asFloat":{"type":"number","format":"float"},"asByte":{"type":"string","format":"byte"},"asCharacter":{"type":"string","deprecated":true},"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asShort":{"type":"integer","format":"int32"}}},"JsonPrimitive":{"type":"object","properties":{"asInt":{"type":"integer","format":"int32"},"asDouble":{"type":"number","format":"double"},"asLong":{"type":"integer","format":"int64"},"asBoolean":{"type":"boolean"},"boolean":{"type":"boolean"},"number":{"type":"boolean"},"asString":{"type":"string"},"asNumber":{"type":"number"},"asFloat":{"type":"number","format":"float"},"asByte":{"type":"string","format":"byte"},"asCharacter":{"type":"string","deprecated":true},"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asShort":{"type":"integer","format":"int32"},"string":{"type":"boolean"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"jsonArray":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"},"jsonNull":{"type":"boolean"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"}}},"JsonArray":{"type":"object","properties":{"asInt":{"type":"integer","format":"int32"},"asDouble":{"type":"number","format":"double"},"asLong":{"type":"integer","format":"int64"},"asBoolean":{"type":"boolean"},"asString":{"type":"string"},"asNumber":{"type":"number"},"asFloat":{"type":"number","format":"float"},"asByte":{"type":"string","format":"byte"},"asCharacter":{"type":"string","deprecated":true},"asBigDecimal":{"type":"number"},"asBigInteger":{"type":"integer"},"asShort":{"type":"integer","format":"int32"},"empty":{"type":"boolean"},"asJsonObject":{"$ref":"#/components/schemas/JsonObject"},"asJsonArray":{"$ref":"#/components/schemas/JsonArray"},"jsonArray":{"type":"boolean"},"jsonObject":{"type":"boolean"},"jsonPrimitive":{"type":"boolean"},"jsonNull":{"type":"boolean"},"asJsonPrimitive":{"$ref":"#/components/schemas/JsonPrimitive"},"asJsonNull":{"$ref":"#/components/schemas/JsonNull"}}},"TestClock":{"type":"object","properties":{"created":{"type":"integer","format":"int64"},"deleted":{"type":"boolean"},"deletesAfter":{"type":"integer","format":"int64"},"frozenTime":{"type":"integer","format":"int64"},"id":{"type":"string"},"livemode":{"type":"boolean"},"name":{"type":"string"},"object":{"type":"string"},"status":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"StripeResponseGetter":{"type":"object"},"Customer":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"balance":{"type":"integer","format":"int64"},"cashBalance":{"$ref":"#/components/schemas/CashBalance"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"defaultSource":{"type":"string"},"deleted":{"type":"boolean"},"delinquent":{"type":"boolean"},"description":{"type":"string"},"discount":{"$ref":"#/components/schemas/Discount"},"email":{"type":"string"},"id":{"type":"string"},"invoiceCreditBalance":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"invoicePrefix":{"type":"string"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"nextInvoiceSequence":{"type":"integer","format":"int64"},"object":{"type":"string"},"phone":{"type":"string"},"preferredLocales":{"type":"array","items":{"type":"string"}},"shipping":{"$ref":"#/components/schemas/ShippingDetails"},"sources":{"$ref":"#/components/schemas/PaymentSourceCollection"},"subscriptions":{"$ref":"#/components/schemas/SubscriptionCollection"},"tax":{"$ref":"#/components/schemas/Tax"},"taxExempt":{"type":"string"},"taxIds":{"$ref":"#/components/schemas/TaxIdCollection"},"testClock":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"testHelpers":{"$ref":"#/components/schemas/TestHelpers"},"defaultSourceObject":{"$ref":"#/components/schemas/PaymentSource"},"testClockObject":{"$ref":"#/components/schemas/TestClock"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentSource":{"type":"object","properties":{"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"id":{"type":"string"}}},"TestHelpers":{"type":"object"},"TaxIdCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"RequestOptions":{"type":"object","properties":{"apiKey":{"type":"string"},"clientId":{"type":"string"},"idempotencyKey":{"type":"string"},"stripeAccount":{"type":"string"},"baseUrl":{"type":"string"},"stripeVersion":{"type":"string"},"connectTimeout":{"type":"integer","format":"int32"},"readTimeout":{"type":"integer","format":"int32"},"maxNetworkRetries":{"type":"integer","format":"int32"},"connectionProxy":{"type":"object"},"proxyCredential":{"type":"object","properties":{"userName":{"type":"string"},"password":{"type":"array","items":{"type":"string"}}}}}},"Verification":{"type":"object","properties":{"status":{"type":"string"},"verifiedAddress":{"type":"string"},"verifiedName":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Tax":{"type":"object","properties":{"automaticTax":{"type":"string"},"ipAddress":{"type":"string"},"location":{"$ref":"#/components/schemas/Location"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Location":{"type":"object","properties":{"country":{"type":"string"},"source":{"type":"string"},"state":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Subscription"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"PaymentSourceCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/PaymentSource"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"ShippingDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"carrier":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"trackingNumber":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Address":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Discount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"discount":{"$ref":"#/components/schemas/Discount"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CashBalance":{"type":"object","properties":{"available":{"type":"object","additionalProperties":{"type":"integer","format":"int64"}},"customer":{"type":"string"},"livemode":{"type":"boolean"},"object":{"type":"string"},"settings":{"$ref":"#/components/schemas/Settings"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Settings":{"type":"object","properties":{"reconciliationMode":{"type":"string"},"usingMerchantDefault":{"type":"boolean"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Application":{"type":"object","properties":{"deleted":{"type":"boolean"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Prebilling":{"type":"object","properties":{"invoice":{"type":"string"},"periodEnd":{"type":"integer","format":"int64"},"periodStart":{"type":"integer","format":"int64"},"updateBehavior":{"type":"string"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Invoice":{"type":"object","properties":{"accountCountry":{"type":"string"},"accountName":{"type":"string"},"accountTaxIds":{"type":"array","items":{"type":"string"}},"amountDue":{"type":"integer","format":"int64"},"amountPaid":{"type":"integer","format":"int64"},"amountRemaining":{"type":"integer","format":"int64"},"amountShipping":{"type":"integer","format":"int64"},"amountsDue":{"type":"array","items":{"$ref":"#/components/schemas/AmountsDue"}},"application":{"type":"string"},"applicationFeeAmount":{"type":"integer","format":"int64"},"attemptCount":{"type":"integer","format":"int64"},"attempted":{"type":"boolean"},"autoAdvance":{"type":"boolean"},"automaticTax":{"$ref":"#/components/schemas/AutomaticTax"},"billingReason":{"type":"string"},"charge":{"type":"string"},"collectionMethod":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"customFields":{"type":"array","items":{"$ref":"#/components/schemas/CustomField"}},"customer":{"type":"string"},"customerAddress":{"$ref":"#/components/schemas/Address"},"customerEmail":{"type":"string"},"customerName":{"type":"string"},"customerPhone":{"type":"string"},"customerShipping":{"$ref":"#/components/schemas/ShippingDetails"},"customerTaxExempt":{"type":"string"},"customerTaxIds":{"type":"array","items":{"$ref":"#/components/schemas/CustomerTaxId"}},"defaultMargins":{"type":"array","items":{"type":"string"}},"defaultPaymentMethod":{"type":"string"},"defaultSource":{"type":"string"},"defaultTaxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"deleted":{"type":"boolean"},"description":{"type":"string"},"discount":{"$ref":"#/components/schemas/Discount"},"discounts":{"type":"array","items":{"type":"string"}},"dueDate":{"type":"integer","format":"int64"},"effectiveAt":{"type":"integer","format":"int64"},"endingBalance":{"type":"integer","format":"int64"},"footer":{"type":"string"},"fromInvoice":{"$ref":"#/components/schemas/FromInvoice"},"hostedInvoiceUrl":{"type":"string"},"id":{"type":"string"},"invoicePdf":{"type":"string"},"issuer":{"$ref":"#/components/schemas/Issuer"},"lastFinalizationError":{"$ref":"#/components/schemas/StripeError"},"latestRevision":{"type":"string"},"lines":{"$ref":"#/components/schemas/InvoiceLineItemCollection"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"nextPaymentAttempt":{"type":"integer","format":"int64"},"number":{"type":"string"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"paid":{"type":"boolean"},"paidOutOfBand":{"type":"boolean"},"paymentIntent":{"type":"string"},"paymentSettings":{"$ref":"#/components/schemas/PaymentSettings"},"payments":{"$ref":"#/components/schemas/InvoicePaymentCollection"},"periodEnd":{"type":"integer","format":"int64"},"periodStart":{"type":"integer","format":"int64"},"postPaymentCreditNotesAmount":{"type":"integer","format":"int64"},"prePaymentCreditNotesAmount":{"type":"integer","format":"int64"},"quote":{"type":"string"},"receiptNumber":{"type":"string"},"rendering":{"$ref":"#/components/schemas/Rendering"},"renderingOptions":{"$ref":"#/components/schemas/RenderingOptions"},"shippingCost":{"$ref":"#/components/schemas/ShippingCost"},"shippingDetails":{"$ref":"#/components/schemas/ShippingDetails"},"startingBalance":{"type":"integer","format":"int64"},"statementDescriptor":{"type":"string"},"status":{"type":"string"},"statusTransitions":{"$ref":"#/components/schemas/StatusTransitions"},"subscription":{"type":"string"},"subscriptionDetails":{"$ref":"#/components/schemas/SubscriptionDetails"},"subscriptionProrationDate":{"type":"integer","format":"int64"},"subtotal":{"type":"integer","format":"int64"},"subtotalExcludingTax":{"type":"integer","format":"int64"},"tax":{"type":"integer","format":"int64"},"testClock":{"type":"string"},"thresholdReason":{"$ref":"#/components/schemas/ThresholdReason"},"total":{"type":"integer","format":"int64"},"totalDiscountAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TotalDiscountAmount"}},"totalExcludingTax":{"type":"integer","format":"int64"},"totalMarginAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TotalMarginAmount"}},"totalTaxAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TotalTaxAmount"}},"transferData":{"$ref":"#/components/schemas/TransferData"},"webhooksDeliveredAt":{"type":"integer","format":"int64"},"discountObjects":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"subscriptionObject":{"$ref":"#/components/schemas/Subscription"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"latestRevisionObject":{"$ref":"#/components/schemas/Invoice"},"paymentIntentObject":{"$ref":"#/components/schemas/PaymentIntent"},"quoteObject":{"$ref":"#/components/schemas/Quote"},"accountTaxIdObjects":{"type":"array","items":{"$ref":"#/components/schemas/TaxId"}},"defaultMarginObjects":{"type":"array","items":{"$ref":"#/components/schemas/Margin"}},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"defaultPaymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"defaultSourceObject":{"$ref":"#/components/schemas/PaymentSource"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"testClockObject":{"$ref":"#/components/schemas/TestClock"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Account":{"type":"object","properties":{"businessProfile":{"$ref":"#/components/schemas/BusinessProfile"},"businessType":{"type":"string"},"capabilities":{"$ref":"#/components/schemas/Capabilities"},"chargesEnabled":{"type":"boolean"},"company":{"$ref":"#/components/schemas/Company"},"controller":{"$ref":"#/components/schemas/Controller"},"country":{"type":"string"},"created":{"type":"integer","format":"int64"},"defaultCurrency":{"type":"string"},"deleted":{"type":"boolean"},"detailsSubmitted":{"type":"boolean"},"email":{"type":"string"},"externalAccounts":{"$ref":"#/components/schemas/ExternalAccountCollection"},"futureRequirements":{"$ref":"#/components/schemas/FutureRequirements"},"id":{"type":"string"},"individual":{"$ref":"#/components/schemas/Person"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"payoutsEnabled":{"type":"boolean"},"requirements":{"$ref":"#/components/schemas/Requirements"},"settings":{"$ref":"#/components/schemas/Settings"},"tosAcceptance":{"$ref":"#/components/schemas/TosAcceptance"},"type":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"TosAcceptance":{"type":"object","properties":{"date":{"type":"integer","format":"int64"},"ip":{"type":"string"},"serviceAgreement":{"type":"string"},"userAgent":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Requirements":{"type":"object","properties":{"alternatives":{"type":"array","items":{"$ref":"#/components/schemas/Alternative"}},"currentDeadline":{"type":"integer","format":"int64"},"currentlyDue":{"type":"array","items":{"type":"string"}},"disabledReason":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Errors"}},"eventuallyDue":{"type":"array","items":{"type":"string"}},"pastDue":{"type":"array","items":{"type":"string"}},"pendingVerification":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Errors":{"type":"object","properties":{"code":{"type":"string"},"reason":{"type":"string"},"requirement":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Alternative":{"type":"object","properties":{"alternativeFieldsDue":{"type":"array","items":{"type":"string"}},"originalFieldsDue":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Person":{"type":"object","properties":{"account":{"type":"string"},"additionalTosAcceptances":{"$ref":"#/components/schemas/AdditionalTosAcceptances"},"address":{"$ref":"#/components/schemas/Address"},"addressKana":{"$ref":"#/components/schemas/AddressKana"},"addressKanji":{"$ref":"#/components/schemas/AddressKanji"},"created":{"type":"integer","format":"int64"},"deleted":{"type":"boolean"},"dob":{"$ref":"#/components/schemas/Dob"},"email":{"type":"string"},"firstName":{"type":"string"},"firstNameKana":{"type":"string"},"firstNameKanji":{"type":"string"},"fullNameAliases":{"type":"array","items":{"type":"string"}},"futureRequirements":{"$ref":"#/components/schemas/FutureRequirements"},"gender":{"type":"string"},"id":{"type":"string"},"idNumberProvided":{"type":"boolean"},"idNumberSecondaryProvided":{"type":"boolean"},"lastName":{"type":"string"},"lastNameKana":{"type":"string"},"lastNameKanji":{"type":"string"},"maidenName":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"nationality":{"type":"string"},"object":{"type":"string"},"phone":{"type":"string"},"politicalExposure":{"type":"string"},"registeredAddress":{"$ref":"#/components/schemas/Address"},"relationship":{"$ref":"#/components/schemas/Relationship"},"requirements":{"$ref":"#/components/schemas/Requirements"},"ssnLast4Provided":{"type":"boolean"},"verification":{"$ref":"#/components/schemas/Verification"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FutureRequirements":{"type":"object","properties":{"alternatives":{"type":"array","items":{"$ref":"#/components/schemas/Alternative"}},"currentlyDue":{"type":"array","items":{"type":"string"}},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Errors"}},"eventuallyDue":{"type":"array","items":{"type":"string"}},"pastDue":{"type":"array","items":{"type":"string"}},"pendingVerification":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Dob":{"type":"object","properties":{"day":{"type":"integer","format":"int64"},"month":{"type":"integer","format":"int64"},"year":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AddressKanji":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string"},"town":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AddressKana":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"line1":{"type":"string"},"line2":{"type":"string"},"postalCode":{"type":"string"},"state":{"type":"string"},"town":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AdditionalTosAcceptances":{"type":"object","properties":{"account":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ExternalAccountCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/ExternalAccount"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"ExternalAccount":{"type":"object","properties":{"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"id":{"type":"string"}}},"Controller":{"type":"object","properties":{"application":{"$ref":"#/components/schemas/Application"},"dashboard":{"$ref":"#/components/schemas/Dashboard"},"isController":{"type":"boolean"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Dashboard":{"type":"object","properties":{"displayName":{"type":"string"},"timezone":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Company":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"addressKana":{"$ref":"#/components/schemas/AddressKana"},"addressKanji":{"$ref":"#/components/schemas/AddressKanji"},"directorsProvided":{"type":"boolean"},"executivesProvided":{"type":"boolean"},"exportLicenseId":{"type":"string"},"exportPurposeCode":{"type":"string"},"name":{"type":"string"},"nameKana":{"type":"string"},"nameKanji":{"type":"string"},"ownersProvided":{"type":"boolean"},"ownershipDeclaration":{"$ref":"#/components/schemas/OwnershipDeclaration"},"phone":{"type":"string"},"structure":{"type":"string"},"taxIdProvided":{"type":"boolean"},"taxIdRegistrar":{"type":"string"},"vatIdProvided":{"type":"boolean"},"verification":{"$ref":"#/components/schemas/Verification"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"OwnershipDeclaration":{"type":"object","properties":{"date":{"type":"integer","format":"int64"},"ip":{"type":"string"},"userAgent":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Capabilities":{"type":"object","properties":{"acssDebitPayments":{"type":"string"},"affirmPayments":{"type":"string"},"afterpayClearpayPayments":{"type":"string"},"auBecsDebitPayments":{"type":"string"},"bacsDebitPayments":{"type":"string"},"bancontactPayments":{"type":"string"},"bankTransferPayments":{"type":"string"},"blikPayments":{"type":"string"},"boletoPayments":{"type":"string"},"cardIssuing":{"type":"string"},"cardPayments":{"type":"string"},"cartesBancairesPayments":{"type":"string"},"cashappPayments":{"type":"string"},"epsPayments":{"type":"string"},"fpxPayments":{"type":"string"},"giropayPayments":{"type":"string"},"grabpayPayments":{"type":"string"},"idealPayments":{"type":"string"},"indiaInternationalPayments":{"type":"string"},"jcbPayments":{"type":"string"},"klarnaPayments":{"type":"string"},"konbiniPayments":{"type":"string"},"legacyPayments":{"type":"string"},"linkPayments":{"type":"string"},"oxxoPayments":{"type":"string"},"p24Payments":{"type":"string"},"paynowPayments":{"type":"string"},"paypalPayments":{"type":"string"},"promptpayPayments":{"type":"string"},"revolutPayPayments":{"type":"string"},"sepaDebitPayments":{"type":"string"},"sofortPayments":{"type":"string"},"taxReportingUs1099K":{"type":"string"},"taxReportingUs1099Misc":{"type":"string"},"transfers":{"type":"string"},"treasury":{"type":"string"},"usBankAccountAchPayments":{"type":"string"},"zipPayments":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BusinessProfile":{"type":"object","properties":{"annualRevenue":{"$ref":"#/components/schemas/AnnualRevenue"},"estimatedWorkerCount":{"type":"integer","format":"int64"},"mcc":{"type":"string"},"monthlyEstimatedRevenue":{"$ref":"#/components/schemas/MonthlyEstimatedRevenue"},"name":{"type":"string"},"productDescription":{"type":"string"},"supportAddress":{"$ref":"#/components/schemas/Address"},"supportEmail":{"type":"string"},"supportPhone":{"type":"string"},"supportUrl":{"type":"string"},"url":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MonthlyEstimatedRevenue":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"currency":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AnnualRevenue":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"currency":{"type":"string"},"fiscalYearEnd":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentMethod":{"type":"object","properties":{"acssDebit":{"$ref":"#/components/schemas/AcssDebit"},"affirm":{"$ref":"#/components/schemas/Affirm"},"afterpayClearpay":{"$ref":"#/components/schemas/AfterpayClearpay"},"alipay":{"$ref":"#/components/schemas/Alipay"},"auBecsDebit":{"$ref":"#/components/schemas/AuBecsDebit"},"bacsDebit":{"$ref":"#/components/schemas/BacsDebit"},"bancontact":{"$ref":"#/components/schemas/Bancontact"},"billingDetails":{"$ref":"#/components/schemas/BillingDetails"},"blik":{"$ref":"#/components/schemas/Blik"},"boleto":{"$ref":"#/components/schemas/Boleto"},"card":{"$ref":"#/components/schemas/Card"},"cardPresent":{"$ref":"#/components/schemas/CardPresent"},"cashapp":{"$ref":"#/components/schemas/Cashapp"},"created":{"type":"integer","format":"int64"},"customer":{"type":"string"},"customerBalance":{"$ref":"#/components/schemas/CustomerBalance"},"eps":{"$ref":"#/components/schemas/Eps"},"fpx":{"$ref":"#/components/schemas/Fpx"},"giropay":{"$ref":"#/components/schemas/Giropay"},"grabpay":{"$ref":"#/components/schemas/Grabpay"},"id":{"type":"string"},"ideal":{"$ref":"#/components/schemas/Ideal"},"interacPresent":{"$ref":"#/components/schemas/InteracPresent"},"klarna":{"$ref":"#/components/schemas/Klarna"},"konbini":{"$ref":"#/components/schemas/Konbini"},"link":{"$ref":"#/components/schemas/Link"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"oxxo":{"$ref":"#/components/schemas/Oxxo"},"p24":{"$ref":"#/components/schemas/P24"},"paynow":{"$ref":"#/components/schemas/Paynow"},"paypal":{"$ref":"#/components/schemas/Paypal"},"pix":{"$ref":"#/components/schemas/Pix"},"promptpay":{"$ref":"#/components/schemas/Promptpay"},"radarOptions":{"$ref":"#/components/schemas/RadarOptions"},"revolutPay":{"$ref":"#/components/schemas/RevolutPay"},"sepaDebit":{"$ref":"#/components/schemas/SepaDebit"},"sofort":{"$ref":"#/components/schemas/Sofort"},"type":{"type":"string"},"usBankAccount":{"$ref":"#/components/schemas/UsBankAccount"},"wechatPay":{"$ref":"#/components/schemas/WechatPay"},"zip":{"$ref":"#/components/schemas/Zip"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"customerObject":{"$ref":"#/components/schemas/Customer"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Zip":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"WechatPay":{"type":"object","properties":{"appId":{"type":"string"},"client":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"UsBankAccount":{"type":"object","properties":{"financialConnections":{"$ref":"#/components/schemas/FinancialConnections"},"mandateOptions":{"$ref":"#/components/schemas/MandateOptions"},"preferredSettlementSpeed":{"type":"string"},"setupFutureUsage":{"type":"string"},"verificationMethod":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MandateOptions":{"type":"object","properties":{"collectionMethod":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FinancialConnections":{"type":"object","properties":{"manualEntry":{"$ref":"#/components/schemas/ManualEntry"},"permissions":{"type":"array","items":{"type":"string"}},"prefetch":{"type":"array","items":{"type":"string"}},"returnUrl":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ManualEntry":{"type":"object","properties":{"mode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Sofort":{"type":"object","properties":{"preferredLanguage":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SepaDebit":{"type":"object","properties":{"bankCode":{"type":"string"},"branchCode":{"type":"string"},"country":{"type":"string"},"fingerprint":{"type":"string"},"generatedFrom":{"$ref":"#/components/schemas/GeneratedFrom"},"last4":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"GeneratedFrom":{"type":"object","properties":{"charge":{"type":"string"},"setupAttempt":{"type":"string"},"setupAttemptObject":{"$ref":"#/components/schemas/SetupAttempt"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Charge":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountCaptured":{"type":"integer","format":"int64"},"amountRefunded":{"type":"integer","format":"int64"},"application":{"type":"string"},"applicationFee":{"type":"string"},"applicationFeeAmount":{"type":"integer","format":"int64"},"authorizationCode":{"type":"string"},"balanceTransaction":{"type":"string"},"billingDetails":{"$ref":"#/components/schemas/BillingDetails"},"calculatedStatementDescriptor":{"type":"string"},"captured":{"type":"boolean"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"customer":{"type":"string"},"description":{"type":"string"},"disputed":{"type":"boolean"},"failureBalanceTransaction":{"type":"string"},"failureCode":{"type":"string"},"failureMessage":{"type":"string"},"fraudDetails":{"$ref":"#/components/schemas/FraudDetails"},"id":{"type":"string"},"invoice":{"type":"string"},"level3":{"$ref":"#/components/schemas/Level3"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"outcome":{"$ref":"#/components/schemas/Outcome"},"paid":{"type":"boolean"},"paymentIntent":{"type":"string"},"paymentMethod":{"type":"string"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"radarOptions":{"$ref":"#/components/schemas/RadarOptions"},"receiptEmail":{"type":"string"},"receiptNumber":{"type":"string"},"receiptUrl":{"type":"string"},"refunded":{"type":"boolean"},"refunds":{"$ref":"#/components/schemas/RefundCollection"},"review":{"type":"string"},"shipping":{"$ref":"#/components/schemas/ShippingDetails"},"source":{"$ref":"#/components/schemas/PaymentSource"},"sourceTransfer":{"type":"string"},"statementDescriptor":{"type":"string"},"statementDescriptorSuffix":{"type":"string"},"status":{"type":"string"},"transfer":{"type":"string"},"transferData":{"$ref":"#/components/schemas/TransferData"},"transferGroup":{"type":"string"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"applicationFeeObject":{"$ref":"#/components/schemas/ApplicationFee"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"failureBalanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"reviewObject":{"$ref":"#/components/schemas/Review"},"sourceTransferObject":{"$ref":"#/components/schemas/Transfer"},"transferObject":{"$ref":"#/components/schemas/Transfer"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"paymentIntentObject":{"$ref":"#/components/schemas/PaymentIntent"},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"PaymentIntent":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountCapturable":{"type":"integer","format":"int64"},"amountDetails":{"$ref":"#/components/schemas/AmountDetails"},"amountReceived":{"type":"integer","format":"int64"},"application":{"type":"string"},"applicationFeeAmount":{"type":"integer","format":"int64"},"automaticPaymentMethods":{"$ref":"#/components/schemas/AutomaticPaymentMethods"},"canceledAt":{"type":"integer","format":"int64"},"cancellationReason":{"type":"string"},"captureMethod":{"type":"string"},"clientSecret":{"type":"string"},"confirmationMethod":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"customer":{"type":"string"},"description":{"type":"string"},"id":{"type":"string"},"invoice":{"type":"string"},"lastPaymentError":{"$ref":"#/components/schemas/StripeError"},"latestCharge":{"type":"string"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"nextAction":{"$ref":"#/components/schemas/NextAction"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"paymentDetails":{"$ref":"#/components/schemas/PaymentDetails"},"paymentMethod":{"type":"string"},"paymentMethodConfigurationDetails":{"$ref":"#/components/schemas/PaymentMethodConfigurationDetails"},"paymentMethodOptions":{"$ref":"#/components/schemas/PaymentMethodOptions"},"paymentMethodTypes":{"type":"array","items":{"type":"string"}},"processing":{"$ref":"#/components/schemas/Processing"},"receiptEmail":{"type":"string"},"review":{"type":"string"},"secretKeyConfirmation":{"type":"string"},"setupFutureUsage":{"type":"string"},"shipping":{"$ref":"#/components/schemas/ShippingDetails"},"source":{"type":"string"},"statementDescriptor":{"type":"string"},"statementDescriptorSuffix":{"type":"string"},"status":{"type":"string"},"transferData":{"$ref":"#/components/schemas/TransferData"},"transferGroup":{"type":"string"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"paymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"latestChargeObject":{"$ref":"#/components/schemas/Charge"},"sourceObject":{"$ref":"#/components/schemas/PaymentSource"},"reviewObject":{"$ref":"#/components/schemas/Review"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Review":{"type":"object","properties":{"billingZip":{"type":"string"},"charge":{"type":"string"},"closedReason":{"type":"string"},"created":{"type":"integer","format":"int64"},"id":{"type":"string"},"ipAddress":{"type":"string"},"ipAddressLocation":{"$ref":"#/components/schemas/IpAddressLocation"},"livemode":{"type":"boolean"},"object":{"type":"string"},"open":{"type":"boolean"},"openedReason":{"type":"string"},"paymentIntent":{"type":"string"},"reason":{"type":"string"},"session":{"$ref":"#/components/schemas/Session"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"paymentIntentObject":{"$ref":"#/components/schemas/PaymentIntent"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Session":{"type":"object","properties":{"browser":{"type":"string"},"device":{"type":"string"},"platform":{"type":"string"},"version":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"IpAddressLocation":{"type":"object","properties":{"city":{"type":"string"},"country":{"type":"string"},"latitude":{"type":"number"},"longitude":{"type":"number"},"region":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TransferData":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountPercent":{"type":"number"},"destination":{"type":"string"},"destinationObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Processing":{"type":"object","properties":{"card":{"$ref":"#/components/schemas/Card"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Card":{"type":"object","properties":{"customerNotification":{"$ref":"#/components/schemas/CustomerNotification"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomerNotification":{"type":"object","properties":{"approvalRequested":{"type":"boolean"},"completesAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentMethodOptions":{"type":"object","properties":{"acssDebit":{"$ref":"#/components/schemas/AcssDebit"},"affirm":{"$ref":"#/components/schemas/Affirm"},"afterpayClearpay":{"$ref":"#/components/schemas/AfterpayClearpay"},"alipay":{"$ref":"#/components/schemas/Alipay"},"auBecsDebit":{"$ref":"#/components/schemas/AuBecsDebit"},"bacsDebit":{"$ref":"#/components/schemas/BacsDebit"},"bancontact":{"$ref":"#/components/schemas/Bancontact"},"blik":{"$ref":"#/components/schemas/Blik"},"boleto":{"$ref":"#/components/schemas/Boleto"},"card":{"$ref":"#/components/schemas/Card"},"cardPresent":{"$ref":"#/components/schemas/CardPresent"},"cashapp":{"$ref":"#/components/schemas/Cashapp"},"customerBalance":{"$ref":"#/components/schemas/CustomerBalance"},"eps":{"$ref":"#/components/schemas/Eps"},"fpx":{"$ref":"#/components/schemas/Fpx"},"giropay":{"$ref":"#/components/schemas/Giropay"},"grabpay":{"$ref":"#/components/schemas/Grabpay"},"ideal":{"$ref":"#/components/schemas/Ideal"},"interacPresent":{"$ref":"#/components/schemas/InteracPresent"},"klarna":{"$ref":"#/components/schemas/Klarna"},"konbini":{"$ref":"#/components/schemas/Konbini"},"link":{"$ref":"#/components/schemas/Link"},"oxxo":{"$ref":"#/components/schemas/Oxxo"},"p24":{"$ref":"#/components/schemas/P24"},"paynow":{"$ref":"#/components/schemas/Paynow"},"paypal":{"$ref":"#/components/schemas/Paypal"},"pix":{"$ref":"#/components/schemas/Pix"},"promptpay":{"$ref":"#/components/schemas/Promptpay"},"revolutPay":{"$ref":"#/components/schemas/RevolutPay"},"sepaDebit":{"$ref":"#/components/schemas/SepaDebit"},"sofort":{"$ref":"#/components/schemas/Sofort"},"usBankAccount":{"$ref":"#/components/schemas/UsBankAccount"},"wechatPay":{"$ref":"#/components/schemas/WechatPay"},"zip":{"$ref":"#/components/schemas/Zip"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"RevolutPay":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Promptpay":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Pix":{"type":"object","properties":{"expiresAfterSeconds":{"type":"integer","format":"int64"},"expiresAt":{"type":"integer","format":"int64"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Paypal":{"type":"object","properties":{"captureMethod":{"type":"string"},"preferredLocale":{"type":"string"},"reference":{"type":"string"},"referenceId":{"type":"string"},"setupFutureUsage":{"type":"string"},"subsellers":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Paynow":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"P24":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Oxxo":{"type":"object","properties":{"expiresAfterDays":{"type":"integer","format":"int64"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Link":{"type":"object","properties":{"captureMethod":{"type":"string"},"persistentToken":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Konbini":{"type":"object","properties":{"confirmationNumber":{"type":"string"},"expiresAfterDays":{"type":"integer","format":"int64"},"expiresAt":{"type":"integer","format":"int64"},"productDescription":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Klarna":{"type":"object","properties":{"captureMethod":{"type":"string"},"preferredLocale":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"InteracPresent":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Ideal":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Grabpay":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Giropay":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Fpx":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Eps":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomerBalance":{"type":"object","properties":{"bankTransfer":{"$ref":"#/components/schemas/BankTransfer"},"fundingType":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BankTransfer":{"type":"object","properties":{"euBankTransfer":{"$ref":"#/components/schemas/EuBankTransfer"},"requestedAddressTypes":{"type":"array","items":{"type":"string"}},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"EuBankTransfer":{"type":"object","properties":{"country":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Cashapp":{"type":"object","properties":{"captureMethod":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CardPresent":{"type":"object","properties":{"requestExtendedAuthorization":{"type":"boolean"},"requestIncrementalAuthorizationSupport":{"type":"boolean"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Boleto":{"type":"object","properties":{"expiresAfterDays":{"type":"integer","format":"int64"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Blik":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Bancontact":{"type":"object","properties":{"preferredLanguage":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BacsDebit":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AuBecsDebit":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Alipay":{"type":"object","properties":{"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AfterpayClearpay":{"type":"object","properties":{"captureMethod":{"type":"string"},"reference":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Affirm":{"type":"object","properties":{"captureMethod":{"type":"string"},"preferredLocale":{"type":"string"},"setupFutureUsage":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AcssDebit":{"type":"object","properties":{"mandateOptions":{"$ref":"#/components/schemas/MandateOptions"},"setupFutureUsage":{"type":"string"},"verificationMethod":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentMethodConfigurationDetails":{"type":"object","properties":{"id":{"type":"string"},"parent":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentDetails":{"type":"object","properties":{"carRental":{"$ref":"#/components/schemas/CarRental"},"eventDetails":{"$ref":"#/components/schemas/EventDetails"},"subscription":{"$ref":"#/components/schemas/Subscription"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"EventDetails":{"type":"object","properties":{"accessControlledVenue":{"type":"boolean"},"address":{"$ref":"#/components/schemas/Address"},"affiliate":{"$ref":"#/components/schemas/Affiliate"},"company":{"type":"string"},"delivery":{"$ref":"#/components/schemas/Delivery"},"endsAt":{"type":"integer","format":"int64"},"genre":{"type":"string"},"name":{"type":"string"},"startsAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Delivery":{"type":"object","properties":{"mode":{"type":"string"},"recipient":{"$ref":"#/components/schemas/Recipient"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Recipient":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Affiliate":{"type":"object","properties":{"name":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CarRental":{"type":"object","properties":{"affiliate":{"$ref":"#/components/schemas/Affiliate"},"bookingNumber":{"type":"string"},"carClassCode":{"type":"string"},"carMake":{"type":"string"},"carModel":{"type":"string"},"company":{"type":"string"},"customerServicePhoneNumber":{"type":"string"},"daysRented":{"type":"integer","format":"int64"},"delivery":{"$ref":"#/components/schemas/Delivery"},"drivers":{"type":"array","items":{"$ref":"#/components/schemas/Driver"}},"extraCharges":{"type":"array","items":{"type":"string"}},"noShow":{"type":"boolean"},"pickupAddress":{"$ref":"#/components/schemas/Address"},"pickupAt":{"type":"integer","format":"int64"},"rateAmount":{"type":"integer","format":"int64"},"rateInterval":{"type":"string"},"renterName":{"type":"string"},"returnAddress":{"$ref":"#/components/schemas/Address"},"returnAt":{"type":"integer","format":"int64"},"taxExempt":{"type":"boolean"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Driver":{"type":"object","properties":{"name":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"NextAction":{"type":"object","properties":{"alipayHandleRedirect":{"$ref":"#/components/schemas/AlipayHandleRedirect"},"boletoDisplayDetails":{"$ref":"#/components/schemas/BoletoDisplayDetails"},"cardAwaitNotification":{"$ref":"#/components/schemas/CardAwaitNotification"},"cashappHandleRedirectOrDisplayQrCode":{"$ref":"#/components/schemas/CashappHandleRedirectOrDisplayQrCode"},"displayBankTransferInstructions":{"$ref":"#/components/schemas/DisplayBankTransferInstructions"},"konbiniDisplayDetails":{"$ref":"#/components/schemas/KonbiniDisplayDetails"},"oxxoDisplayDetails":{"$ref":"#/components/schemas/OxxoDisplayDetails"},"paynowDisplayQrCode":{"$ref":"#/components/schemas/PaynowDisplayQrCode"},"pixDisplayQrCode":{"$ref":"#/components/schemas/PixDisplayQrCode"},"promptpayDisplayQrCode":{"$ref":"#/components/schemas/PromptpayDisplayQrCode"},"redirectToUrl":{"$ref":"#/components/schemas/RedirectToUrl"},"type":{"type":"string"},"useStripeSdk":{"type":"object","additionalProperties":{"type":"object"}},"verifyWithMicrodeposits":{"$ref":"#/components/schemas/VerifyWithMicrodeposits"},"wechatPayDisplayQrCode":{"$ref":"#/components/schemas/WechatPayDisplayQrCode"},"wechatPayRedirectToAndroidApp":{"$ref":"#/components/schemas/WechatPayRedirectToAndroidApp"},"wechatPayRedirectToIosApp":{"$ref":"#/components/schemas/WechatPayRedirectToIosApp"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"WechatPayRedirectToIosApp":{"type":"object","properties":{"nativeUrl":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"WechatPayRedirectToAndroidApp":{"type":"object","properties":{"appId":{"type":"string"},"nonceStr":{"type":"string"},"partnerId":{"type":"string"},"prepayId":{"type":"string"},"sign":{"type":"string"},"timestamp":{"type":"string"},"package_":{"type":"string"},"package":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"WechatPayDisplayQrCode":{"type":"object","properties":{"data":{"type":"string"},"hostedInstructionsUrl":{"type":"string"},"imageDataUrl":{"type":"string"},"imageUrlPng":{"type":"string"},"imageUrlSvg":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"VerifyWithMicrodeposits":{"type":"object","properties":{"arrivalDate":{"type":"integer","format":"int64"},"hostedVerificationUrl":{"type":"string"},"microdepositType":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"RedirectToUrl":{"type":"object","properties":{"returnUrl":{"type":"string"},"url":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PromptpayDisplayQrCode":{"type":"object","properties":{"data":{"type":"string"},"hostedInstructionsUrl":{"type":"string"},"imageUrlPng":{"type":"string"},"imageUrlSvg":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PixDisplayQrCode":{"type":"object","properties":{"data":{"type":"string"},"expiresAt":{"type":"integer","format":"int64"},"hostedInstructionsUrl":{"type":"string"},"imageUrlPng":{"type":"string"},"imageUrlSvg":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaynowDisplayQrCode":{"type":"object","properties":{"data":{"type":"string"},"hostedInstructionsUrl":{"type":"string"},"imageUrlPng":{"type":"string"},"imageUrlSvg":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"OxxoDisplayDetails":{"type":"object","properties":{"expiresAfter":{"type":"integer","format":"int64"},"hostedVoucherUrl":{"type":"string"},"number":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"KonbiniDisplayDetails":{"type":"object","properties":{"expiresAt":{"type":"integer","format":"int64"},"hostedVoucherUrl":{"type":"string"},"stores":{"$ref":"#/components/schemas/Stores"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Stores":{"type":"object","properties":{"familymart":{"$ref":"#/components/schemas/Familymart"},"lawson":{"$ref":"#/components/schemas/Lawson"},"ministop":{"$ref":"#/components/schemas/Ministop"},"seicomart":{"$ref":"#/components/schemas/Seicomart"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Seicomart":{"type":"object","properties":{"confirmationNumber":{"type":"string"},"paymentCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Ministop":{"type":"object","properties":{"confirmationNumber":{"type":"string"},"paymentCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Lawson":{"type":"object","properties":{"confirmationNumber":{"type":"string"},"paymentCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Familymart":{"type":"object","properties":{"confirmationNumber":{"type":"string"},"paymentCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"DisplayBankTransferInstructions":{"type":"object","properties":{"amountRemaining":{"type":"integer","format":"int64"},"currency":{"type":"string"},"financialAddresses":{"type":"array","items":{"$ref":"#/components/schemas/FinancialAddress"}},"hostedInstructionsUrl":{"type":"string"},"reference":{"type":"string"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FinancialAddress":{"type":"object","properties":{"aba":{"$ref":"#/components/schemas/Aba"},"iban":{"$ref":"#/components/schemas/Iban"},"sortCode":{"$ref":"#/components/schemas/SortCode"},"spei":{"$ref":"#/components/schemas/Spei"},"supportedNetworks":{"type":"array","items":{"type":"string"}},"swift":{"$ref":"#/components/schemas/Swift"},"type":{"type":"string"},"zengin":{"$ref":"#/components/schemas/Zengin"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Zengin":{"type":"object","properties":{"accountHolderName":{"type":"string"},"accountNumber":{"type":"string"},"accountType":{"type":"string"},"bankCode":{"type":"string"},"bankName":{"type":"string"},"branchCode":{"type":"string"},"branchName":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Swift":{"type":"object","properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"swiftCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Spei":{"type":"object","properties":{"bankCode":{"type":"string"},"bankName":{"type":"string"},"clabe":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SortCode":{"type":"object","properties":{"accountHolderName":{"type":"string"},"accountNumber":{"type":"string"},"sortCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Iban":{"type":"object","properties":{"accountHolderName":{"type":"string"},"bic":{"type":"string"},"country":{"type":"string"},"iban":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Aba":{"type":"object","properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"routingNumber":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CashappHandleRedirectOrDisplayQrCode":{"type":"object","properties":{"hostedInstructionsUrl":{"type":"string"},"mobileAuthUrl":{"type":"string"},"qrCode":{"$ref":"#/components/schemas/QrCode"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"QrCode":{"type":"object","properties":{"expiresAt":{"type":"integer","format":"int64"},"imageUrlPng":{"type":"string"},"imageUrlSvg":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CardAwaitNotification":{"type":"object","properties":{"chargeAttemptAt":{"type":"integer","format":"int64"},"customerApprovalRequired":{"type":"boolean"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BoletoDisplayDetails":{"type":"object","properties":{"expiresAt":{"type":"integer","format":"int64"},"hostedVoucherUrl":{"type":"string"},"number":{"type":"string"},"pdf":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AlipayHandleRedirect":{"type":"object","properties":{"nativeData":{"type":"string"},"nativeUrl":{"type":"string"},"returnUrl":{"type":"string"},"url":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"StripeError":{"type":"object","properties":{"charge":{"type":"string"},"code":{"type":"string"},"declineCode":{"type":"string"},"docUrl":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"paymentIntent":{"$ref":"#/components/schemas/PaymentIntent"},"paymentMethod":{"$ref":"#/components/schemas/PaymentMethod"},"paymentMethodType":{"type":"string"},"requestLogUrl":{"type":"string"},"setupIntent":{"$ref":"#/components/schemas/SetupIntent"},"source":{"$ref":"#/components/schemas/PaymentSource"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SetupIntent":{"type":"object","properties":{"application":{"type":"string"},"attachToSelf":{"type":"boolean"},"automaticPaymentMethods":{"$ref":"#/components/schemas/AutomaticPaymentMethods"},"cancellationReason":{"type":"string"},"clientSecret":{"type":"string"},"created":{"type":"integer","format":"int64"},"customer":{"type":"string"},"description":{"type":"string"},"flowDirections":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"lastSetupError":{"$ref":"#/components/schemas/StripeError"},"latestAttempt":{"type":"string"},"livemode":{"type":"boolean"},"mandate":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"nextAction":{"$ref":"#/components/schemas/NextAction"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"paymentMethod":{"type":"string"},"paymentMethodConfigurationDetails":{"$ref":"#/components/schemas/PaymentMethodConfigurationDetails"},"paymentMethodOptions":{"$ref":"#/components/schemas/PaymentMethodOptions"},"paymentMethodTypes":{"type":"array","items":{"type":"string"}},"singleUseMandate":{"type":"string"},"status":{"type":"string"},"usage":{"type":"string"},"latestAttemptObject":{"$ref":"#/components/schemas/SetupAttempt"},"mandateObject":{"$ref":"#/components/schemas/Mandate"},"paymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"singleUseMandateObject":{"$ref":"#/components/schemas/Mandate"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Mandate":{"type":"object","properties":{"customerAcceptance":{"$ref":"#/components/schemas/CustomerAcceptance"},"id":{"type":"string"},"livemode":{"type":"boolean"},"multiUse":{"$ref":"#/components/schemas/MultiUse"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"paymentMethod":{"type":"string"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"singleUse":{"$ref":"#/components/schemas/SingleUse"},"status":{"type":"string"},"type":{"type":"string"},"paymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SingleUse":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"currency":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentMethodDetails":{"type":"object","properties":{"achCreditTransfer":{"$ref":"#/components/schemas/AchCreditTransfer"},"achDebit":{"$ref":"#/components/schemas/AchDebit"},"acssDebit":{"$ref":"#/components/schemas/AcssDebit"},"affirm":{"$ref":"#/components/schemas/Affirm"},"afterpayClearpay":{"$ref":"#/components/schemas/AfterpayClearpay"},"alipay":{"$ref":"#/components/schemas/Alipay"},"auBecsDebit":{"$ref":"#/components/schemas/AuBecsDebit"},"bacsDebit":{"$ref":"#/components/schemas/BacsDebit"},"bancontact":{"$ref":"#/components/schemas/Bancontact"},"blik":{"$ref":"#/components/schemas/Blik"},"boleto":{"$ref":"#/components/schemas/Boleto"},"card":{"$ref":"#/components/schemas/Card"},"cardPresent":{"$ref":"#/components/schemas/CardPresent"},"cashapp":{"$ref":"#/components/schemas/Cashapp"},"customerBalance":{"$ref":"#/components/schemas/CustomerBalance"},"eps":{"$ref":"#/components/schemas/Eps"},"fpx":{"$ref":"#/components/schemas/Fpx"},"giropay":{"$ref":"#/components/schemas/Giropay"},"grabpay":{"$ref":"#/components/schemas/Grabpay"},"ideal":{"$ref":"#/components/schemas/Ideal"},"interacPresent":{"$ref":"#/components/schemas/InteracPresent"},"klarna":{"$ref":"#/components/schemas/Klarna"},"konbini":{"$ref":"#/components/schemas/Konbini"},"link":{"$ref":"#/components/schemas/Link"},"multibanco":{"$ref":"#/components/schemas/Multibanco"},"oxxo":{"$ref":"#/components/schemas/Oxxo"},"p24":{"$ref":"#/components/schemas/P24"},"paynow":{"$ref":"#/components/schemas/Paynow"},"paypal":{"$ref":"#/components/schemas/Paypal"},"pix":{"$ref":"#/components/schemas/Pix"},"promptpay":{"$ref":"#/components/schemas/Promptpay"},"revolutPay":{"$ref":"#/components/schemas/RevolutPay"},"sepaCreditTransfer":{"$ref":"#/components/schemas/SepaCreditTransfer"},"sepaDebit":{"$ref":"#/components/schemas/SepaDebit"},"sofort":{"$ref":"#/components/schemas/Sofort"},"stripeAccount":{"$ref":"#/components/schemas/StripeAccount"},"type":{"type":"string"},"usBankAccount":{"$ref":"#/components/schemas/UsBankAccount"},"wechat":{"$ref":"#/components/schemas/Wechat"},"wechatPay":{"$ref":"#/components/schemas/WechatPay"},"zip":{"$ref":"#/components/schemas/Zip"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Wechat":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"StripeAccount":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SepaCreditTransfer":{"type":"object","properties":{"bankName":{"type":"string"},"bic":{"type":"string"},"iban":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Multibanco":{"type":"object","properties":{"entity":{"type":"string"},"reference":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AchDebit":{"type":"object","properties":{"accountHolderType":{"type":"string"},"bankName":{"type":"string"},"country":{"type":"string"},"fingerprint":{"type":"string"},"last4":{"type":"string"},"routingNumber":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AchCreditTransfer":{"type":"object","properties":{"accountNumber":{"type":"string"},"bankName":{"type":"string"},"routingNumber":{"type":"string"},"swiftCode":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MultiUse":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomerAcceptance":{"type":"object","properties":{"acceptedAt":{"type":"integer","format":"int64"},"offline":{"$ref":"#/components/schemas/Offline"},"online":{"$ref":"#/components/schemas/Online"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Online":{"type":"object","properties":{"ipAddress":{"type":"string"},"userAgent":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Offline":{"type":"object","properties":{"storedAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SetupAttempt":{"type":"object","properties":{"application":{"type":"string"},"attachToSelf":{"type":"boolean"},"created":{"type":"integer","format":"int64"},"customer":{"type":"string"},"flowDirections":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"livemode":{"type":"boolean"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"paymentMethod":{"type":"string"},"paymentMethodDetails":{"$ref":"#/components/schemas/PaymentMethodDetails"},"setupError":{"$ref":"#/components/schemas/StripeError"},"setupIntent":{"type":"string"},"status":{"type":"string"},"usage":{"type":"string"},"paymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"setupIntentObject":{"$ref":"#/components/schemas/SetupIntent"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AutomaticPaymentMethods":{"type":"object","properties":{"allowRedirects":{"type":"string"},"enabled":{"type":"boolean"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AmountDetails":{"type":"object","properties":{"tip":{"$ref":"#/components/schemas/Tip"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Tip":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Transfer":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountReversed":{"type":"integer","format":"int64"},"balanceTransaction":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"description":{"type":"string"},"destination":{"type":"string"},"destinationPayment":{"type":"string"},"id":{"type":"string"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"reversals":{"$ref":"#/components/schemas/TransferReversalCollection"},"reversed":{"type":"boolean"},"sourceTransaction":{"type":"string"},"sourceType":{"type":"string"},"transferGroup":{"type":"string"},"destinationPaymentObject":{"$ref":"#/components/schemas/Charge"},"sourceTransactionObject":{"$ref":"#/components/schemas/Charge"},"destinationObject":{"$ref":"#/components/schemas/Account"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"BalanceTransaction":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"availableOn":{"type":"integer","format":"int64"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"description":{"type":"string"},"exchangeRate":{"type":"number"},"fee":{"type":"integer","format":"int64"},"feeDetails":{"type":"array","items":{"$ref":"#/components/schemas/FeeDetail"}},"id":{"type":"string"},"net":{"type":"integer","format":"int64"},"object":{"type":"string"},"reportingCategory":{"type":"string"},"source":{"type":"string"},"status":{"type":"string"},"type":{"type":"string"},"sourceObject":{"$ref":"#/components/schemas/BalanceTransactionSource"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BalanceTransactionSource":{"type":"object","properties":{"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"id":{"type":"string"}}},"FeeDetail":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"application":{"type":"string"},"currency":{"type":"string"},"description":{"type":"string"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TransferReversalCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/TransferReversal"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"TransferReversal":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"balanceTransaction":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"destinationPaymentRefund":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"sourceRefund":{"type":"string"},"transfer":{"type":"string"},"destinationPaymentRefundObject":{"$ref":"#/components/schemas/Refund"},"sourceRefundObject":{"$ref":"#/components/schemas/Refund"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"transferObject":{"$ref":"#/components/schemas/Transfer"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"Refund":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"balanceTransaction":{"type":"string"},"charge":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"description":{"type":"string"},"destinationDetails":{"$ref":"#/components/schemas/DestinationDetails"},"failureBalanceTransaction":{"type":"string"},"failureReason":{"type":"string"},"id":{"type":"string"},"instructionsEmail":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"nextAction":{"$ref":"#/components/schemas/NextAction"},"object":{"type":"string"},"paymentIntent":{"type":"string"},"reason":{"type":"string"},"receiptNumber":{"type":"string"},"sourceTransferReversal":{"type":"string"},"status":{"type":"string"},"transferReversal":{"type":"string"},"sourceTransferReversalObject":{"$ref":"#/components/schemas/TransferReversal"},"transferReversalObject":{"$ref":"#/components/schemas/TransferReversal"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"failureBalanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"testHelpers":{"$ref":"#/components/schemas/TestHelpers"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"paymentIntentObject":{"$ref":"#/components/schemas/PaymentIntent"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"DestinationDetails":{"type":"object","properties":{"affirm":{"$ref":"#/components/schemas/Affirm"},"afterpayClearpay":{"$ref":"#/components/schemas/AfterpayClearpay"},"alipay":{"$ref":"#/components/schemas/Alipay"},"auBankTransfer":{"$ref":"#/components/schemas/AuBankTransfer"},"blik":{"$ref":"#/components/schemas/Blik"},"brBankTransfer":{"$ref":"#/components/schemas/BrBankTransfer"},"card":{"$ref":"#/components/schemas/Card"},"cashapp":{"$ref":"#/components/schemas/Cashapp"},"customerCashBalance":{"$ref":"#/components/schemas/CustomerCashBalance"},"eps":{"$ref":"#/components/schemas/Eps"},"euBankTransfer":{"$ref":"#/components/schemas/EuBankTransfer"},"gbBankTransfer":{"$ref":"#/components/schemas/GbBankTransfer"},"giropay":{"$ref":"#/components/schemas/Giropay"},"grabpay":{"$ref":"#/components/schemas/Grabpay"},"jpBankTransfer":{"$ref":"#/components/schemas/JpBankTransfer"},"klarna":{"$ref":"#/components/schemas/Klarna"},"mxBankTransfer":{"$ref":"#/components/schemas/MxBankTransfer"},"p24":{"$ref":"#/components/schemas/P24"},"paynow":{"$ref":"#/components/schemas/Paynow"},"paypal":{"$ref":"#/components/schemas/Paypal"},"pix":{"$ref":"#/components/schemas/Pix"},"revolut":{"$ref":"#/components/schemas/Revolut"},"sofort":{"$ref":"#/components/schemas/Sofort"},"thBankTransfer":{"$ref":"#/components/schemas/ThBankTransfer"},"type":{"type":"string"},"usBankTransfer":{"$ref":"#/components/schemas/UsBankTransfer"},"wechatPay":{"$ref":"#/components/schemas/WechatPay"},"zip":{"$ref":"#/components/schemas/Zip"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"UsBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ThBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Revolut":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MxBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"JpBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"GbBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomerCashBalance":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BrBankTransfer":{"type":"object","properties":{"reference":{"type":"string"},"referenceStatus":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AuBankTransfer":{"type":"object","properties":{"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ApplicationFee":{"type":"object","properties":{"account":{"type":"string"},"amount":{"type":"integer","format":"int64"},"amountRefunded":{"type":"integer","format":"int64"},"application":{"type":"string"},"balanceTransaction":{"type":"string"},"charge":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"id":{"type":"string"},"livemode":{"type":"boolean"},"object":{"type":"string"},"originatingTransaction":{"type":"string"},"refunded":{"type":"boolean"},"refunds":{"$ref":"#/components/schemas/FeeRefundCollection"},"originatingTransactionObject":{"$ref":"#/components/schemas/Charge"},"accountObject":{"$ref":"#/components/schemas/Account"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"applicationObject":{"$ref":"#/components/schemas/Application"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"FeeRefundCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/FeeRefund"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"FeeRefund":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"balanceTransaction":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"fee":{"type":"string"},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"feeObject":{"$ref":"#/components/schemas/ApplicationFee"},"balanceTransactionObject":{"$ref":"#/components/schemas/BalanceTransaction"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"RefundCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/Refund"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"RadarOptions":{"type":"object","properties":{"session":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Outcome":{"type":"object","properties":{"networkStatus":{"type":"string"},"reason":{"type":"string"},"riskLevel":{"type":"string"},"riskScore":{"type":"integer","format":"int64"},"rule":{"type":"string"},"sellerMessage":{"type":"string"},"type":{"type":"string"},"ruleObject":{"$ref":"#/components/schemas/Rule"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Rule":{"type":"object","properties":{"action":{"type":"string"},"id":{"type":"string"},"predicate":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Level3":{"type":"object","properties":{"customerReference":{"type":"string"},"lineItems":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"merchantReference":{"type":"string"},"shippingAddressZip":{"type":"string"},"shippingAmount":{"type":"integer","format":"int64"},"shippingFromZip":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LineItem":{"type":"object","properties":{"amountDiscount":{"type":"integer","format":"int64"},"amountSubtotal":{"type":"integer","format":"int64"},"amountTax":{"type":"integer","format":"int64"},"amountTotal":{"type":"integer","format":"int64"},"currency":{"type":"string"},"description":{"type":"string"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"id":{"type":"string"},"object":{"type":"string"},"price":{"$ref":"#/components/schemas/Price"},"product":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"productObject":{"$ref":"#/components/schemas/Product"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Product":{"type":"object","properties":{"active":{"type":"boolean"},"created":{"type":"integer","format":"int64"},"defaultPrice":{"type":"string"},"deleted":{"type":"boolean"},"description":{"type":"string"},"features":{"type":"array","items":{"$ref":"#/components/schemas/Feature"}},"id":{"type":"string"},"images":{"type":"array","items":{"type":"string"}},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"object":{"type":"string"},"packageDimensions":{"$ref":"#/components/schemas/PackageDimensions"},"provisioning":{"$ref":"#/components/schemas/Provisioning"},"shippable":{"type":"boolean"},"statementDescriptor":{"type":"string"},"taxCode":{"type":"string"},"type":{"type":"string"},"unitLabel":{"type":"string"},"updated":{"type":"integer","format":"int64"},"url":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"defaultPriceObject":{"$ref":"#/components/schemas/Price"},"taxCodeObject":{"$ref":"#/components/schemas/TaxCode"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TaxCode":{"type":"object","properties":{"description":{"type":"string"},"id":{"type":"string"},"name":{"type":"string"},"object":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Price":{"type":"object","properties":{"active":{"type":"boolean"},"billingScheme":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"currencyOptions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CurrencyOption"}},"customUnitAmount":{"$ref":"#/components/schemas/CustomUnitAmount"},"deleted":{"type":"boolean"},"id":{"type":"string"},"livemode":{"type":"boolean"},"lookupKey":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"migrateTo":{"$ref":"#/components/schemas/MigrateTo"},"nickname":{"type":"string"},"object":{"type":"string"},"product":{"type":"string"},"recurring":{"$ref":"#/components/schemas/Recurring"},"taxBehavior":{"type":"string"},"tiers":{"type":"array","items":{"$ref":"#/components/schemas/Tier"}},"tiersMode":{"type":"string"},"transformQuantity":{"$ref":"#/components/schemas/TransformQuantity"},"type":{"type":"string"},"unitAmount":{"type":"integer","format":"int64"},"unitAmountDecimal":{"type":"number"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"productObject":{"$ref":"#/components/schemas/Product"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TransformQuantity":{"type":"object","properties":{"divideBy":{"type":"integer","format":"int64"},"round":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Tier":{"type":"object","properties":{"flatAmount":{"type":"integer","format":"int64"},"flatAmountDecimal":{"type":"number"},"unitAmount":{"type":"integer","format":"int64"},"unitAmountDecimal":{"type":"number"},"upTo":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Recurring":{"type":"object","properties":{"amountSubtotal":{"type":"integer","format":"int64"},"amountTotal":{"type":"integer","format":"int64"},"interval":{"type":"string"},"intervalCount":{"type":"integer","format":"int64"},"totalDetails":{"$ref":"#/components/schemas/TotalDetails"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TotalDetails":{"type":"object","properties":{"amountDiscount":{"type":"integer","format":"int64"},"amountShipping":{"type":"integer","format":"int64"},"amountTax":{"type":"integer","format":"int64"},"breakdown":{"$ref":"#/components/schemas/Breakdown"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Breakdown":{"type":"object","properties":{"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MigrateTo":{"type":"object","properties":{"behavior":{"type":"string"},"effectiveAfter":{"type":"integer","format":"int64"},"price":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomUnitAmount":{"type":"object","properties":{"maximum":{"type":"integer","format":"int64"},"minimum":{"type":"integer","format":"int64"},"preset":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CurrencyOption":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"taxBehavior":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Provisioning":{"type":"object","properties":{"giftCard":{"$ref":"#/components/schemas/GiftCard"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"GiftCard":{"type":"object","properties":{"fixedAmount":{"$ref":"#/components/schemas/FixedAmount"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FixedAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"currency":{"type":"string"},"currencyOptions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CurrencyOption"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PackageDimensions":{"type":"object","properties":{"height":{"type":"number"},"length":{"type":"number"},"weight":{"type":"number"},"width":{"type":"number"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Feature":{"type":"object","properties":{"name":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FraudDetails":{"type":"object","properties":{"stripeReport":{"type":"string"},"userReport":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BillingDetails":{"type":"object","properties":{"address":{"$ref":"#/components/schemas/Address"},"email":{"type":"string"},"name":{"type":"string"},"phone":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Margin":{"type":"object","properties":{"active":{"type":"boolean"},"created":{"type":"integer","format":"int64"},"id":{"type":"string"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"object":{"type":"string"},"percentOff":{"type":"number"},"updated":{"type":"integer","format":"int64"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Quote":{"type":"object","properties":{"allowBackdatedLines":{"type":"boolean"},"amountSubtotal":{"type":"integer","format":"int64"},"amountTotal":{"type":"integer","format":"int64"},"application":{"type":"string"},"applicationFeeAmount":{"type":"integer","format":"int64"},"applicationFeePercent":{"type":"number"},"automaticTax":{"$ref":"#/components/schemas/AutomaticTax"},"collectionMethod":{"type":"string"},"computed":{"$ref":"#/components/schemas/Computed"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"customer":{"type":"string"},"defaultTaxRates":{"type":"array","items":{"type":"string"}},"description":{"type":"string"},"discounts":{"type":"array","items":{"type":"string"}},"expiresAt":{"type":"integer","format":"int64"},"footer":{"type":"string"},"fromQuote":{"$ref":"#/components/schemas/FromQuote"},"header":{"type":"string"},"id":{"type":"string"},"invoice":{"type":"string"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"lineItems":{"$ref":"#/components/schemas/LineItemCollection"},"lines":{"type":"array","items":{"type":"string"}},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"number":{"type":"string"},"object":{"type":"string"},"onBehalfOf":{"type":"string"},"status":{"type":"string"},"statusDetails":{"$ref":"#/components/schemas/StatusDetails"},"statusTransitions":{"$ref":"#/components/schemas/StatusTransitions"},"subscription":{"type":"string"},"subscriptionData":{"$ref":"#/components/schemas/SubscriptionData"},"subscriptionDataOverrides":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionDataOverride"}},"subscriptionSchedule":{"type":"string"},"subscriptionSchedules":{"type":"array","items":{"$ref":"#/components/schemas/SubscriptionSchedule"}},"testClock":{"type":"string"},"totalDetails":{"$ref":"#/components/schemas/TotalDetails"},"transferData":{"$ref":"#/components/schemas/TransferData"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"subscriptionScheduleObject":{"$ref":"#/components/schemas/SubscriptionSchedule"},"defaultTaxRateObjects":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"discountObjects":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"subscriptionObject":{"$ref":"#/components/schemas/Subscription"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"applicationObject":{"$ref":"#/components/schemas/Application"},"customerObject":{"$ref":"#/components/schemas/Customer"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"testClockObject":{"$ref":"#/components/schemas/TestClock"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TaxRate":{"type":"object","properties":{"active":{"type":"boolean"},"country":{"type":"string"},"created":{"type":"integer","format":"int64"},"description":{"type":"string"},"displayName":{"type":"string"},"effectivePercentage":{"type":"number"},"id":{"type":"string"},"inclusive":{"type":"boolean"},"jurisdiction":{"type":"string"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"percentage":{"type":"number"},"state":{"type":"string"},"taxType":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionDataOverride":{"type":"object","properties":{"appliesTo":{"$ref":"#/components/schemas/AppliesTo"},"billOnAcceptance":{"$ref":"#/components/schemas/BillOnAcceptance"},"billingBehavior":{"type":"string"},"customer":{"type":"string"},"description":{"type":"string"},"endBehavior":{"type":"string"},"prorationBehavior":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BillOnAcceptance":{"type":"object","properties":{"billFrom":{"$ref":"#/components/schemas/BillFrom"},"billUntil":{"$ref":"#/components/schemas/BillUntil"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BillUntil":{"type":"object","properties":{"computed":{"type":"integer","format":"int64"},"duration":{"$ref":"#/components/schemas/Duration"},"lineEndsAt":{"$ref":"#/components/schemas/LineEndsAt"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LineEndsAt":{"type":"object","properties":{"id":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BillFrom":{"type":"object","properties":{"computed":{"type":"integer","format":"int64"},"lineStartsAt":{"$ref":"#/components/schemas/LineStartsAt"},"timestamp":{"type":"integer","format":"int64"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LineStartsAt":{"type":"object","properties":{"id":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AppliesTo":{"type":"object","properties":{"newReference":{"type":"string"},"subscriptionSchedule":{"type":"string"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionData":{"type":"object","properties":{"billOnAcceptance":{"$ref":"#/components/schemas/BillOnAcceptance"},"billingBehavior":{"type":"string"},"billingCycleAnchor":{"type":"string"},"description":{"type":"string"},"effectiveDate":{"type":"integer","format":"int64"},"endBehavior":{"type":"string"},"fromSchedule":{"type":"string"},"fromSubscription":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"prebilling":{"$ref":"#/components/schemas/Prebilling"},"prorationBehavior":{"type":"string"},"trialPeriodDays":{"type":"integer","format":"int64"},"fromScheduleObject":{"$ref":"#/components/schemas/SubscriptionSchedule"},"fromSubscriptionObject":{"$ref":"#/components/schemas/Subscription"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"StatusTransitions":{"type":"object","properties":{"acceptedAt":{"type":"integer","format":"int64"},"canceledAt":{"type":"integer","format":"int64"},"finalizedAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"StatusDetails":{"type":"object","properties":{"canceled":{"$ref":"#/components/schemas/Canceled"},"stale":{"$ref":"#/components/schemas/Stale"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Stale":{"type":"object","properties":{"expiresAt":{"type":"integer","format":"int64"},"lastReason":{"$ref":"#/components/schemas/LastReason"},"lastUpdatedAt":{"type":"integer","format":"int64"},"transitionedAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LastReason":{"type":"object","properties":{"lineInvalid":{"type":"string"},"markedStale":{"type":"string"},"subscriptionCanceled":{"type":"string"},"subscriptionChanged":{"$ref":"#/components/schemas/SubscriptionChanged"},"subscriptionExpired":{"type":"string"},"subscriptionScheduleCanceled":{"type":"string"},"subscriptionScheduleChanged":{"$ref":"#/components/schemas/SubscriptionScheduleChanged"},"subscriptionScheduleReleased":{"type":"string"},"type":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionScheduleChanged":{"type":"object","properties":{"previousSubscriptionSchedule":{"$ref":"#/components/schemas/SubscriptionSchedule"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionChanged":{"type":"object","properties":{"previousSubscription":{"$ref":"#/components/schemas/Subscription"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Canceled":{"type":"object","properties":{"reason":{"type":"string"},"transitionedAt":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LineItemCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/LineItem"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"FromQuote":{"type":"object","properties":{"isRevision":{"type":"boolean"},"quote":{"type":"string"},"quoteObject":{"$ref":"#/components/schemas/Quote"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Computed":{"type":"object","properties":{"lastReestimationDetails":{"$ref":"#/components/schemas/LastReestimationDetails"},"recurring":{"$ref":"#/components/schemas/Recurring"},"updatedAt":{"type":"integer","format":"int64"},"upfront":{"$ref":"#/components/schemas/Upfront"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Upfront":{"type":"object","properties":{"amountSubtotal":{"type":"integer","format":"int64"},"amountTotal":{"type":"integer","format":"int64"},"lineItems":{"$ref":"#/components/schemas/LineItemCollection"},"totalDetails":{"$ref":"#/components/schemas/TotalDetails"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"LastReestimationDetails":{"type":"object","properties":{"failed":{"$ref":"#/components/schemas/Failed"},"status":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Failed":{"type":"object","properties":{"failureCode":{"type":"string"},"message":{"type":"string"},"reason":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AutomaticTax":{"type":"object","properties":{"enabled":{"type":"boolean"},"liability":{"$ref":"#/components/schemas/Liability"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Liability":{"type":"object","properties":{"account":{"type":"string"},"type":{"type":"string"},"accountObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TotalTaxAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"inclusive":{"type":"boolean"},"taxRate":{"type":"string"},"taxabilityReason":{"type":"string"},"taxableAmount":{"type":"integer","format":"int64"},"taxRateObject":{"$ref":"#/components/schemas/TaxRate"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TotalMarginAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"margin":{"type":"string"},"marginObject":{"$ref":"#/components/schemas/Margin"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TotalDiscountAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"discount":{"type":"string"},"discountObject":{"$ref":"#/components/schemas/Discount"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ThresholdReason":{"type":"object","properties":{"amountGte":{"type":"integer","format":"int64"},"itemReasons":{"type":"array","items":{"$ref":"#/components/schemas/ItemReason"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ItemReason":{"type":"object","properties":{"lineItemIds":{"type":"array","items":{"type":"string"}},"usageGte":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionDetails":{"type":"object","properties":{"metadata":{"type":"object","additionalProperties":{"type":"string"}},"pauseCollection":{"$ref":"#/components/schemas/PauseCollection"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PauseCollection":{"type":"object","properties":{"behavior":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ShippingCost":{"type":"object","properties":{"amountSubtotal":{"type":"integer","format":"int64"},"amountTax":{"type":"integer","format":"int64"},"amountTotal":{"type":"integer","format":"int64"},"shippingRate":{"type":"string"},"taxes":{"type":"array","items":{"$ref":"#/components/schemas/Tax"}},"shippingRateObject":{"$ref":"#/components/schemas/ShippingRate"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ShippingRate":{"type":"object","properties":{"active":{"type":"boolean"},"created":{"type":"integer","format":"int64"},"deliveryEstimate":{"$ref":"#/components/schemas/DeliveryEstimate"},"displayName":{"type":"string"},"fixedAmount":{"$ref":"#/components/schemas/FixedAmount"},"id":{"type":"string"},"livemode":{"type":"boolean"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"taxBehavior":{"type":"string"},"taxCode":{"type":"string"},"type":{"type":"string"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"taxCodeObject":{"$ref":"#/components/schemas/TaxCode"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"DeliveryEstimate":{"type":"object","properties":{"maximum":{"$ref":"#/components/schemas/Maximum"},"minimum":{"$ref":"#/components/schemas/Minimum"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Minimum":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Maximum":{"type":"object","properties":{"unit":{"type":"string"},"value":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"RenderingOptions":{"type":"object","properties":{"amountTaxDisplay":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Rendering":{"type":"object","properties":{"amountTaxDisplay":{"type":"string"},"pdf":{"$ref":"#/components/schemas/Pdf"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Pdf":{"type":"object","properties":{"pageSize":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"InvoicePaymentCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoicePayment"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"InvoicePayment":{"type":"object","properties":{"amountOverpaid":{"type":"integer","format":"int64"},"amountPaid":{"type":"integer","format":"int64"},"amountRequested":{"type":"integer","format":"int64"},"charge":{"type":"string"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"id":{"type":"string"},"invoice":{"type":"string"},"isDefault":{"type":"boolean"},"livemode":{"type":"boolean"},"object":{"type":"string"},"paymentIntent":{"type":"string"},"status":{"type":"string"},"statusTransitions":{"$ref":"#/components/schemas/StatusTransitions"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"chargeObject":{"$ref":"#/components/schemas/Charge"},"paymentIntentObject":{"$ref":"#/components/schemas/PaymentIntent"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"PaymentSettings":{"type":"object","properties":{"defaultMandate":{"type":"string"},"paymentMethodOptions":{"$ref":"#/components/schemas/PaymentMethodOptions"},"paymentMethodTypes":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"InvoiceLineItemCollection":{"type":"object","properties":{"object":{"type":"string"},"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceLineItem"}},"hasMore":{"type":"boolean"},"url":{"type":"string"},"requestParams":{"type":"object","additionalProperties":{"type":"object"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"pageTypeToken":{"type":"object","properties":{"typeName":{"type":"string"}}},"requestOptions":{"$ref":"#/components/schemas/RequestOptions"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"}}},"InvoiceLineItem":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountExcludingTax":{"type":"integer","format":"int64"},"currency":{"type":"string"},"description":{"type":"string"},"discountAmounts":{"type":"array","items":{"$ref":"#/components/schemas/DiscountAmount"}},"discountable":{"type":"boolean"},"discounts":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"invoiceItem":{"type":"string"},"livemode":{"type":"boolean"},"marginAmounts":{"type":"array","items":{"$ref":"#/components/schemas/MarginAmount"}},"margins":{"type":"array","items":{"type":"string"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"period":{"$ref":"#/components/schemas/Period"},"plan":{"$ref":"#/components/schemas/Plan"},"price":{"$ref":"#/components/schemas/Price"},"proration":{"type":"boolean"},"prorationDetails":{"$ref":"#/components/schemas/ProrationDetails"},"quantity":{"type":"integer","format":"int64"},"subscription":{"type":"string"},"subscriptionItem":{"type":"string"},"taxAmounts":{"type":"array","items":{"$ref":"#/components/schemas/TaxAmount"}},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"type":{"type":"string"},"unitAmountExcludingTax":{"type":"number"},"discountObjects":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"subscriptionObject":{"$ref":"#/components/schemas/Subscription"},"invoiceItemObject":{"$ref":"#/components/schemas/InvoiceItem"},"subscriptionItemObject":{"$ref":"#/components/schemas/SubscriptionItem"},"marginObjects":{"type":"array","items":{"$ref":"#/components/schemas/Margin"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"SubscriptionItem":{"type":"object","properties":{"billingThresholds":{"$ref":"#/components/schemas/BillingThresholds"},"created":{"type":"integer","format":"int64"},"deleted":{"type":"boolean"},"discounts":{"type":"array","items":{"type":"string"}},"id":{"type":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"object":{"type":"string"},"plan":{"$ref":"#/components/schemas/Plan"},"price":{"$ref":"#/components/schemas/Price"},"quantity":{"type":"integer","format":"int64"},"subscription":{"type":"string"},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"trial":{"$ref":"#/components/schemas/Trial"},"discountObjects":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TransformUsage":{"type":"object","properties":{"divideBy":{"type":"integer","format":"int64"},"round":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"BillingThresholds":{"type":"object","properties":{"usageGte":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TaxAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"inclusive":{"type":"boolean"},"taxRate":{"type":"string"},"taxabilityReason":{"type":"string"},"taxableAmount":{"type":"integer","format":"int64"},"taxRateObject":{"$ref":"#/components/schemas/TaxRate"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"ProrationDetails":{"type":"object","properties":{"creditedItems":{"$ref":"#/components/schemas/CreditedItems"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CreditedItems":{"type":"object","properties":{"invoice":{"type":"string"},"invoiceLineItems":{"type":"array","items":{"type":"string"}},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"MarginAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"margin":{"type":"string"},"marginObject":{"$ref":"#/components/schemas/Margin"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"DiscountAmount":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"discount":{"type":"string"},"discountObject":{"$ref":"#/components/schemas/Discount"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Issuer":{"type":"object","properties":{"account":{"type":"string"},"type":{"type":"string"},"accountObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"FromInvoice":{"type":"object","properties":{"action":{"type":"string"},"invoice":{"type":"string"},"invoiceObject":{"$ref":"#/components/schemas/Invoice"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomerTaxId":{"type":"object","properties":{"type":{"type":"string"},"value":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CustomField":{"type":"object","properties":{"name":{"type":"string"},"value":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AmountsDue":{"type":"object","properties":{"amount":{"type":"integer","format":"int64"},"amountPaid":{"type":"integer","format":"int64"},"amountRemaining":{"type":"integer","format":"int64"},"daysUntilDue":{"type":"integer","format":"int64"},"description":{"type":"string"},"dueDate":{"type":"integer","format":"int64"},"paidAt":{"type":"integer","format":"int64"},"status":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Phase":{"type":"object","properties":{"addInvoiceItems":{"type":"array","items":{"$ref":"#/components/schemas/AddInvoiceItem"}},"applicationFeePercent":{"type":"number"},"automaticTax":{"$ref":"#/components/schemas/AutomaticTax"},"billingCycleAnchor":{"type":"string"},"billingThresholds":{"$ref":"#/components/schemas/BillingThresholds"},"collectionMethod":{"type":"string"},"coupon":{"type":"string"},"currency":{"type":"string"},"defaultPaymentMethod":{"type":"string"},"defaultTaxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"description":{"type":"string"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"endDate":{"type":"integer","format":"int64"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"items":{"type":"array","items":{"$ref":"#/components/schemas/Item"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"onBehalfOf":{"type":"string"},"pauseCollection":{"$ref":"#/components/schemas/PauseCollection"},"prorationBehavior":{"type":"string"},"startDate":{"type":"integer","format":"int64"},"transferData":{"$ref":"#/components/schemas/TransferData"},"trialContinuation":{"type":"string"},"trialEnd":{"type":"integer","format":"int64"},"trialSettings":{"$ref":"#/components/schemas/TrialSettings"},"defaultPaymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"couponObject":{"$ref":"#/components/schemas/Coupon"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Coupon":{"type":"object","properties":{"amountOff":{"type":"integer","format":"int64"},"appliesTo":{"$ref":"#/components/schemas/AppliesTo"},"created":{"type":"integer","format":"int64"},"currency":{"type":"string"},"currencyOptions":{"type":"object","additionalProperties":{"$ref":"#/components/schemas/CurrencyOption"}},"deleted":{"type":"boolean"},"duration":{"type":"string"},"durationInMonths":{"type":"integer","format":"int64"},"id":{"type":"string"},"livemode":{"type":"boolean"},"maxRedemptions":{"type":"integer","format":"int64"},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"name":{"type":"string"},"object":{"type":"string"},"percentOff":{"type":"number"},"redeemBy":{"type":"integer","format":"int64"},"timesRedeemed":{"type":"integer","format":"int64"},"valid":{"type":"boolean"},"responseGetter":{"$ref":"#/components/schemas/StripeResponseGetter"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"TrialSettings":{"type":"object","properties":{"endBehavior":{"$ref":"#/components/schemas/EndBehavior"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"EndBehavior":{"type":"object","properties":{"prorateUpFront":{"type":"string"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"Item":{"type":"object","properties":{"billingThresholds":{"$ref":"#/components/schemas/BillingThresholds"},"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"metadata":{"type":"object","additionalProperties":{"type":"string"}},"plan":{"type":"string"},"price":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"trial":{"$ref":"#/components/schemas/Trial"},"planObject":{"$ref":"#/components/schemas/Plan"},"priceObject":{"$ref":"#/components/schemas/Price"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"AddInvoiceItem":{"type":"object","properties":{"discounts":{"type":"array","items":{"$ref":"#/components/schemas/Discount"}},"price":{"type":"string"},"quantity":{"type":"integer","format":"int64"},"taxRates":{"type":"array","items":{"$ref":"#/components/schemas/TaxRate"}},"priceObject":{"$ref":"#/components/schemas/Price"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"DefaultSettings":{"type":"object","properties":{"applicationFeePercent":{"type":"number"},"automaticTax":{"$ref":"#/components/schemas/AutomaticTax"},"billingCycleAnchor":{"type":"string"},"billingThresholds":{"$ref":"#/components/schemas/BillingThresholds"},"collectionMethod":{"type":"string"},"defaultPaymentMethod":{"type":"string"},"description":{"type":"string"},"invoiceSettings":{"$ref":"#/components/schemas/InvoiceSettings"},"onBehalfOf":{"type":"string"},"transferData":{"$ref":"#/components/schemas/TransferData"},"defaultPaymentMethodObject":{"$ref":"#/components/schemas/PaymentMethod"},"onBehalfOfObject":{"$ref":"#/components/schemas/Account"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"CurrentPhase":{"type":"object","properties":{"endDate":{"type":"integer","format":"int64"},"startDate":{"type":"integer","format":"int64"},"rawJsonObject":{"$ref":"#/components/schemas/JsonObject"},"lastResponse":{"$ref":"#/components/schemas/StripeResponse"}}},"UpcomingBillsResponseV2":{"type":"object","properties":{"tax":{"type":"number","description":"Sum of tax in upcoming bills of all line items"},"total":{"type":"number","description":"The total estimate for the quote."},"subTotal":{"type":"number","description":"Sum of subtotal of all line items excluding tax, promotions."},"lines":{"type":"array","description":"Upcoming Bills values for Quote Line Items","items":{"$ref":"#/components/schemas/UpcomingBillsLineResponseV2"}}},"additionalProperties":false,"description":"Upcoming Bills values for the quote"},"UpcomingBillsLineResponseV2":{"type":"object","properties":{"id":{"type":"string","description":"Id for the upcoming bills line item"},"quoteLineId":{"type":"string","description":"Id for the quote line item"},"description":{"type":"string","description":"Estimate Description"},"currency":{"type":"string","description":"Three-letter ISO currency code","enum":["USD","JPY"]},"total":{"type":"number","description":"Upcoming Bills line total"},"subTotal":{"type":"number","description":"Cost of the line item excluding tax, promotions and upgrade credits"},"tax":{"type":"number","description":"Tax on the line item of upcoming bill"},"period":{"$ref":"#/components/schemas/PeriodResponse"},"offeringId":{"type":"string","description":"Product Offering referred in the quote"},"pricingPlanId":{"type":"string","description":"This will store the reference pricing plan id which will determine the list price of the product"},"quantity":{"type":"integer","description":"The quantity for which the user is charged.","format":"int64"},"adjustments":{"type":"array","description":"Discount details for the line item","items":{"$ref":"#/components/schemas/AdjustmentDetailResponse"}},"margins":{"type":"array","description":"Margins for the line item","items":{"$ref":"#/components/schemas/MarginResponse"}},"taxItems":{"type":"array","description":"Tax distribution for the line item","items":{"$ref":"#/components/schemas/TaxItemsResponse"}},"taxPercent":{"type":"number","description":"Percentage value of tax for the line item"},"accruedCharges":{"type":"boolean","description":"Field to represent if the charge line is an accrued line"},"metadata":{"type":"object","additionalProperties":{"type":"string","description":"Metadata for upcoming bills line for a quote line item"},"description":"Metadata for upcoming bills line for a quote line item"}},"additionalProperties":false,"description":"Upcoming Bills values for Quote Line Items"},"OptedQuantity":{"required":["chargeElement","quantity","source"],"type":"object","properties":{"chargeElement":{"type":"string"},"quantity":{"type":"integer","format":"int32"},"source":{"type":"string","enum":["USER_OPTED","INHERITED","CEILING_LIMIT"]}},"additionalProperties":false,"description":"valid quantities or null","nullable":true},"LineCancelledStatusReasonResponse":{"type":"object","properties":{"code":{"type":"string","description":"Reason code for moving to the state"},"name":{"type":"string","description":"Reason for moving to the state"},"lastUpdatedAt":{"type":"integer","description":"Timestamp when the status reason code was last updated","format":"int64"},"orderId":{"type":"string","description":"Order id for quote line item moving to cancel status"},"orderItemId":{"type":"string","description":"Order item id for quote line item moving to cancel status"}},"additionalProperties":false,"description":"Reason for quote line item to move to cancel state"},"LineStaleStatusReasonResponse":{"type":"object","properties":{"code":{"type":"string","description":"Reason code for moving to the state"},"name":{"type":"string","description":"Reason for moving to the state"},"lastUpdatedAt":{"type":"integer","description":"Timestamp when the status reason code was last updated","format":"int64"},"orderId":{"type":"string","description":"Order id for quote moving to stale status"},"orderItemId":{"type":"string","description":"Order item id for quote moving to stale status"}},"additionalProperties":false,"description":"Reason for quote line item to move to stale status"},"PublicPaginatedQuotesEntityGetQuoteResponseV2String":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/GetQuoteResponseV2"}},"nextId":{"type":"string","description":"The startKey for retrieving the next page of response"}},"additionalProperties":false},"PaginatedDataResponseDtoOrderGetResponseDtoV2String":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrderGetResponseDtoV2"}},"nextId":{"type":"string","description":"The startKey for retrieving the next page of response"}}},"PaginatedDataResponseEntitlementSanitizedResponseDtoString":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementSanitizedResponseDto"}},"nextId":{"type":"string"}},"additionalProperties":false},"EntitlementSanitizedResponseDto":{"type":"object","properties":{"entitlementId":{"type":"string"},"invoiceGroupId":{"type":"string"},"version":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"slug":{"type":"string"},"offeringKey":{"type":"string"},"optedQuantities":{"type":"array","items":{"$ref":"#/components/schemas/OptedQuantity"}},"entitlementTemplate":{"$ref":"#/components/schemas/EntitlementSanitizedTemplateDto"},"featureOverrides":{"type":"object","additionalProperties":{"type":"string"}},"featureVariables":{"type":"object","additionalProperties":{"type":"string"}},"transactionAccountId":{"type":"string"},"order":{"$ref":"#/components/schemas/Order"},"relatesToEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementRelationshipDto"}},"relatesFromEntitlements":{"type":"array","items":{"$ref":"#/components/schemas/EntitlementRelationshipDto"}},"createdAt":{"type":"integer","format":"int64"},"updatedAt":{"type":"integer","format":"int64"}},"additionalProperties":false},"EntitlementRelationshipDto":{"type":"object","properties":{"relationshipType":{"type":"string"},"entitlementId":{"type":"string"},"relationshipId":{"type":"string"}},"additionalProperties":false,"description":"Entitlement Relationships linked from this entitlement instance","nullable":true},"EntitlementSanitizedTemplateDto":{"type":"object","properties":{"key":{"type":"string"},"version":{"type":"integer","format":"int32"},"data":{"type":"object","additionalProperties":{"type":"object"}}},"additionalProperties":false},"AutoRefreshResponse":{"type":"object","properties":{"initiatedAt":{"type":"integer","description":"Timestamp in milliseconds at which auto-refresh was initiated by system","format":"int64"},"reason":{"type":"string","description":"Reason why auto-refresh was initiated by the system"}},"additionalProperties":false,"description":"Auto-refresh performed by the system"},"ResetOptionsDto":{"required":["resetGLPOrderItemId","resetType"],"type":"object","properties":{"resetType":{"type":"string","enum":["HARD_RESET","SALE_TRANSITION_RESET"]},"backdateTimestamp":{"type":"integer","format":"int64"},"resetGLPOrderItemId":{"type":"string"},"invoiceRequestId":{"type":"string"}},"nullable":true},"StartsAtEffectiveTimeDto":{"required":["type"],"type":"object","properties":{"type":{"type":"string","enum":["TIMESTAMP"]},"timestamp":{"type":"integer","format":"int64"}}},"EntitlementSummary":{"required":["entitlementId"],"type":"object","properties":{"entitlementId":{"type":"string"},"version":{"type":"integer","format":"int32"},"status":{"type":"string","enum":["ACTIVE","INACTIVE"]},"slug":{"type":"string"},"createdAt":{"type":"integer","format":"int64"},"updatedAt":{"type":"integer","format":"int64"},"offeringKey":{"type":"string"},"transactionAccountId":{"type":"string"},"relatesToEntitlements":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EntitlementRelationship"}},"relatesFromEntitlements":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EntitlementRelationship"}},"subscription":{"$ref":"#/components/schemas/SubscriptionSummary"},"provisionedResource":{"$ref":"#/components/schemas/ProvisionedResource"}},"additionalProperties":false},"ProvisionedResource":{"type":"object","properties":{"ari":{"type":"string"},"name":{"type":"string"}},"additionalProperties":false},"SubscriptionSummary":{"type":"object","properties":{"id":{"type":"string"},"status":{"type":"string","enum":["PROCESSING","NOT_STARTED","ACTIVE","CANCELLED"]},"nextBillingTimestamp":{"type":"integer","format":"int64"},"nextBillingAnchorTimestamp":{"type":"integer","format":"int64"},"trial":{"$ref":"#/components/schemas/Trial"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"chargeDetails":{"$ref":"#/components/schemas/ChargeDetailsSummary"},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"},"startTimestamp":{"type":"integer","format":"int64"},"endTimestamp":{"type":"integer","format":"int64"}},"additionalProperties":false},"PagedListV2InvoiceGroupPublicDto":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/InvoiceGroupPublicDto"}},"nextId":{"type":"string","description":"Use the nextId in your next pageRequest to continue paging from where the PagedList finished. If there weren't enough records left to search in order to fill up the PagedList completely, the value of nextId will be null, therefore you dont have to continue paging.","nullable":true}},"additionalProperties":false},"TestFeatures":{"type":"object","properties":{"billingClockId":{"type":"string"}},"additionalProperties":false,"nullable":true},"OrderIntentWithQuoteWebRequestDtoV2":{"required":["quote"],"type":"object","allOf":[{"$ref":"#/components/schemas/OrderIntentWebRequestDtoV2"},{"type":"object","properties":{"source":{"type":"string","enum":["QUOTE"]},"quote":{"$ref":"#/components/schemas/QuoteReferenceWebDto"}}}]},"QuoteReferenceWebDto":{"required":["id","version"],"type":"object","properties":{"id":{"type":"string","format":"uuid"},"version":{"minimum":1,"type":"integer","format":"int64"}}},"OrderIntentWebRequestDtoV2":{"type":"object","properties":{"source":{"type":"string","enum":["ORDER_ITEMS","QUOTE"]},"orderIntentId":{"type":"string","format":"uuid","nullable":true},"transactionAccountId":{"type":"string","nullable":true}},"discriminator":{"propertyName":"source","mapping":{"QUOTE":"#/components/schemas/OrderIntentWithQuoteWebRequestDtoV2"}}},"BlendedMarginComputation":{"type":"object","properties":{"newGlp":{"type":"number","description":"The Gross List Price of the Quote Line Entitlement Offering"},"previousGlp":{"type":"number","description":"The existing Gross List Price of the Quote Line Entitlement offering"},"upsellPercentage":{"type":"number","description":"The upsell/upgrade margin percentage"},"renewPercentage":{"type":"number","description":"The renewal margin percentage"},"upsellValue":{"type":"number","description":"The upsell/upgrade value for the quote line"},"renewalValue":{"type":"number","description":"The renewal value for the quote line"},"upsellMargin":{"type":"number","description":"The upsell/upgrade margin amount calculated"},"renewalMargin":{"type":"number","description":"The renewal margin amount calculated"},"blendedMargin":{"type":"number","description":"The blended margin amount calculated"}},"additionalProperties":false,"description":"The margin provided, calculated based on the total renewal and upsell amounts"},"ChargeDetailsSummary":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}}},"additionalProperties":false},"SubscriptionScheduleRestricted":{"type":"object","properties":{"nextCycleChange":{"$ref":"#/components/schemas/NextCycleChangeRestricted"}},"additionalProperties":false},"NextCycleChangeRestricted":{"type":"object","properties":{"chargeDetails":{"$ref":"#/components/schemas/NextCycleChargeDetailsRestricted"},"changeTimestamp":{"type":"integer","format":"int64"},"subscriptionScheduleAction":{"type":"string","enum":["UPDATE","CANCEL"]},"orderItemId":{"type":"string"},"pauseBilling":{"$ref":"#/components/schemas/PauseBilling"},"accountDetails":{"$ref":"#/components/schemas/AccountDetails"},"trial":{"$ref":"#/components/schemas/Trial"}},"additionalProperties":false},"NextCycleChargeDetailsRestricted":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstanceRestricted"}}},"additionalProperties":false},"PromotionInstanceRestricted":{"type":"object","properties":{"promotionInstanceId":{"type":"string","description":"the instanceId for an applied promotion","nullable":true},"promotionDefinition":{"$ref":"#/components/schemas/PromotionDefinition"}},"additionalProperties":false,"description":"a list of promotions applied to the subscription","nullable":true},"ChargeDetailsRestricted":{"type":"object","properties":{"offeringId":{"type":"string"},"pricingPlanId":{"type":"string"},"chargeQuantities":{"type":"array","items":{"$ref":"#/components/schemas/ChargeQuantity"}},"promotionInstances":{"type":"array","items":{"$ref":"#/components/schemas/PromotionInstanceRestricted"}}},"additionalProperties":false},"ComputedScheduledChangesDto":{"type":"object","properties":{"chargingDetails":{"$ref":"#/components/schemas/ChargingDetailsDto"}}},"InvoiceRequestItemPlan":{"type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"sku":{"type":"string"},"hostingType":{"type":"string"},"cycle":{"$ref":"#/components/schemas/Cycle"}},"additionalProperties":false},"InvoiceItemSubscription":{"type":"object","properties":{"id":{"type":"string"},"itemId":{"type":"string"},"chargeType":{"type":"string"}},"additionalProperties":false},"InvoiceItemMarginBlendedComputation":{"type":"object","properties":{"newGlp":{"type":"number","description":"The Gross List Price of the Invoice Line Entitlement Offering"},"previousGlp":{"type":"number","description":"The existing Gross List Price of the Invoice Line Entitlement offering"},"upsellValue":{"type":"number","description":"The upsell/upgrade value for the invoice line"},"renewalValue":{"type":"number","description":"The renewal value for the invoice line"},"upsellMargin":{"type":"number","description":"The upsell/upgrade margin amount calculated"},"renewalMargin":{"type":"number","description":"The renewal margin amount calculated"},"blendedMargin":{"type":"number","description":"The blended margin amount calculated"},"upsellPercentage":{"type":"number","description":"The upsell/upgrade margin percentage"},"renewPercentage":{"type":"number","description":"The renewal margin percentage"}},"additionalProperties":false,"description":"The margin provided, calculated based on the total renewal and upsell amounts"},"InvoicingPeriod":{"required":["endAt","startAt"],"type":"object","properties":{"startAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"},"endAt":{"type":"integer","description":"Timestamp in Epoch milliseconds","format":"int64"}},"additionalProperties":false},"CycleResponseDto":{"required":["interval","name"],"type":"object","properties":{"name":{"type":"string"},"interval":{"type":"string","enum":["DAY","WEEK","MONTH","YEAR"]},"count":{"type":"integer","format":"int32"}},"additionalProperties":false}}}}