{
"openapi": "3.1.0",
"info": {
"title": "API Reference",
"description": "Orb's API is built with the following principles in mind:\n\n1. **Predictable developer experience**: Where applicable, the Orb API uses industry-standard patterns such as\ncursor-based pagination and standardized error output. To help with debugging in critical API\nactions, the API always strives to provide detailed and actionable error messages. Aliases\nsuch as external customer IDs aid in fast integration times.\n2. **Reliably real time**: Orb's event-based APIs, such as event ingestion are designed to handle extremely high\nthroughput and scale with concurrent load. Orb also provides a real-time event-level credits\nledger and a highly performant webhooks architecture.\n3. **Flexibility at the forefront**: Features like timezone localization and the ability to amend historical usage\nshow the flexible nature of the platform.\n\nYou can download the latest OpenAPI spec [here](https://api.withorb.com/spec.json) - pass `?version=3.0` for an\nOpenAPI 3.0-compatible spec.",
"contact": {
"name": "Orb, Inc.",
"url": "https://www.withorb.com/",
"email": "team@withorb.com"
},
"version": "1.0"
},
"servers": [
{
"url": "https://api.withorb.com/v1",
"description": "Production server"
}
],
"paths": {
"/alerts": {
"get": {
"tags": [
"Alert"
],
"summary": "List alerts",
"description": "This endpoint returns a list of alerts within Orb.\n\nThe request must specify one of `customer_id`, `external_customer_id`, or `subscription_id`.\n\nIf querying by subscription_id, the endpoint will return the subscription level alerts as well as the plan level alerts\nassociated with the subscription.\n\nThe list of alerts is ordered starting from the most recently created alert.\nThis endpoint follows Orb's [standardized pagination format](/api-reference/pagination).",
"operationId": "list-alerts",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "Fetch alerts scoped to this customer_id"
},
"name": "customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "Fetch alerts scoped to this external_customer_id"
},
"name": "external_customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id",
"description": "Fetch alerts scoped to this subscription_id"
},
"name": "subscription_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alerts"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/customer_id/{customer_id}": {
"post": {
"tags": [
"Alert"
],
"summary": "Create customer alert",
"description": " This endpoint creates a new alert to monitor a customer's credit balance. There are three types of alerts that can be scoped to\n customers: `credit_balance_depleted`, `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have a maximum\n of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).\n`credit_balance_dropped` alerts require a list of thresholds to be provided while `credit_balance_depleted`\n and `credit_balance_recovered` alerts do not require thresholds.",
"operationId": "create-customer-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerAlertRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/external_customer_id/{external_customer_id}": {
"post": {
"tags": [
"Alert"
],
"summary": "Create customer alert by external ID",
"description": " This endpoint creates a new alert to monitor a customer's credit balance. There are three types of alerts that can be scoped to\n customers: `credit_balance_depleted`, `credit_balance_dropped`, and `credit_balance_recovered`. Customers can have a maximum\n of one of each type of alert per [credit balance currency](/product-catalog/prepurchase).\n`credit_balance_dropped` alerts require a list of thresholds to be provided while `credit_balance_depleted`\n and `credit_balance_recovered` alerts do not require thresholds.",
"operationId": "create-customer-alert-external-customer-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCustomerAlertRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/subscription_id/{subscription_id}": {
"post": {
"tags": [
"Alert"
],
"summary": "Create subscription alert",
"description": "This endpoint is used to create alerts at the subscription level.\n\nSubscription level alerts can be one of two types: `usage_exceeded` or `cost_exceeded`. A `usage_exceeded` alert is\nscoped to a particular metric and is triggered when the usage of that metric exceeds predefined thresholds during the\ncurrent billing cycle. A `cost_exceeded` alert is triggered when the total amount due during the current billing cycle surpasses\npredefined thresholds. `cost_exceeded` alerts do not include burndown of pre-purchase credits. Each subscription can have one\n`cost_exceeded` alert and one `usage_exceeded` alert per metric that is a part of the subscription. Alerts are triggered based\non usage or cost conditions met during the current billing cycle.",
"operationId": "create-subscription-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSubscriptionAlertRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/{alert_configuration_id}": {
"put": {
"tags": [
"Alert"
],
"summary": "Update alert",
"description": "This endpoint updates the thresholds of an alert.",
"operationId": "update-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "alert_configuration_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateAlertRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/{alert_configuration_id}/disable": {
"post": {
"tags": [
"Alert"
],
"summary": "Disable alert by ID",
"description": "This endpoint allows you to disable an alert. To disable a plan-level alert for a specific subscription, you must include\nthe `subscription_id`. The `subscription_id` is not required for customer or subscription level alerts.",
"operationId": "disable-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "alert_configuration_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id",
"description": "Used to update the status of a plan alert scoped to this subscription_id"
},
"name": "subscription_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/{alert_configuration_id}/enable": {
"post": {
"tags": [
"Alert"
],
"summary": "Enable alert by ID",
"description": "This endpoint allows you to enable an alert. To enable a plan-level alert for a specific subscription, you must include\nthe `subscription_id`. The `subscription_id` is not required for customer or subscription level alerts.",
"operationId": "enable-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "alert_configuration_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id",
"description": "Used to update the status of a plan alert scoped to this subscription_id"
},
"name": "subscription_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/alerts/{alert_id}": {
"get": {
"tags": [
"Alert"
],
"summary": "Fetch alert",
"description": "This endpoint retrieves an alert by its ID.",
"operationId": "fetch-alert",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "alert_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Alert"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/coupons": {
"get": {
"tags": [
"Coupon"
],
"summary": "List coupons",
"description": "This endpoint returns a list of all coupons for an account in a list format.\n\nThe list of coupons is ordered starting from the most recently created coupon. The response also includes\n`pagination_metadata`, which lets the caller retrieve the next page of results if they exist.",
"operationId": "list-coupons",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Show Archived",
"description": "Show archived coupons as well (by default, this endpoint only returns active coupons)."
},
"name": "show_archived",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Redemption Code",
"description": "Filter to coupons matching this redemption code."
},
"name": "redemption_code",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Coupons"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Coupon"
],
"summary": "Create coupon",
"description": "This endpoint allows the creation of coupons, which can then be redeemed at subscription creation or plan change.",
"operationId": "create-coupon",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewCoupon"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Coupon"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/coupons/{coupon_id}": {
"get": {
"tags": [
"Coupon"
],
"summary": "Fetch coupon",
"description": "This endpoint retrieves a coupon by its ID. To fetch coupons by their redemption code, use the\n[List coupons](list-coupons) endpoint with the redemption_code parameter.",
"operationId": "fetch-coupon",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "coupon_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Coupon"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/coupons/{coupon_id}/archive": {
"post": {
"tags": [
"Coupon"
],
"summary": "Archive coupon",
"description": "This endpoint allows a coupon to be archived. Archived coupons can no longer be redeemed, and\nwill be hidden from lists of active coupons. Additionally, once a coupon is archived, its redemption\ncode can be reused for a different coupon.",
"operationId": "archive-coupon",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "coupon_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Coupon"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/coupons/{coupon_id}/subscriptions": {
"get": {
"tags": [
"Coupon"
],
"summary": "List coupon subscriptions",
"description": "This endpoint returns a list of all subscriptions that have redeemed a given coupon as a\n[paginated](/api-reference/pagination) list, ordered starting from the most recently created subscription. For a full\ndiscussion of the subscription resource, see [Subscription](/core-concepts#subscription).",
"operationId": "list-coupon-subscriptions",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "coupon_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriptions"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/credit_blocks/{block_id}": {
"get": {
"tags": [
"Credit"
],
"summary": "Fetch credit block",
"description": "This endpoint returns a credit block identified by its block_id.",
"operationId": "fetch-credit-block",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "block_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditBlock"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"delete": {
"tags": [
"Credit"
],
"summary": "Delete credit block",
"description": "This endpoint deletes a credit block by its ID.\n\nWhen a credit block is deleted:\n- The block is removed from the customer's credit ledger.\n- Any usage of the credit block is reversed, and the ledger is replayed as if the block never existed.\n- If invoices were generated from the purchase of the credit block, they will be deleted if in draft status,\n voided if issued, or a credit note will be issued if the invoice is paid.\n\n\nIssued invoices that had credits applied from this block will not be regenerated, but the ledger will\nreflect the state as if credits from the deleted block were never applied.\n",
"operationId": "delete-credit-block",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "block_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/credit_blocks/{block_id}/invoices": {
"get": {
"tags": [
"Credit"
],
"summary": "List invoices for credit block",
"description": "This endpoint returns the credit block and its associated purchasing invoices.\n\nIf a credit block was purchased (as opposed to being manually added),\nthis endpoint returns the invoices that were created to charge the customer for the credit block.\nFor credit blocks with payment schedules spanning multiple periods (e.g., monthly payments over 12 months),\nmultiple invoices will be returned.\n\nFor credit blocks created by subscription allocation prices, this endpoint returns the subscription\ninvoice containing the allocation line item that created the block.\n\nIf the credit block was not purchased (e.g., manual increment), an empty invoices list is returned.\n\n**Note: This endpoint is currently experimental and its interface may change in future releases.\nPlease contact support before building production integrations against this endpoint.**",
"operationId": "list-credit-block-invoices",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "block_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditBlockInvoicesResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/credit_notes": {
"get": {
"tags": [
"Credit note"
],
"summary": "List credit notes",
"description": "Get a paginated list of CreditNotes. Users can also filter by\ncustomer_id, subscription_id, or external_customer_id. The credit notes will be returned\nin reverse chronological order by `creation_time`.",
"operationId": "list-credit-notes",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNotes"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Credit note"
],
"summary": "Create credit note",
"description": "This endpoint is used to create a single [`Credit Note`](/invoicing/credit-notes).\n\nThe credit note service period configuration supports two explicit modes:\n\n1. Global service periods: Specify start_date and end_date at the credit note level.\n These dates will be applied to all line items uniformly.\n\n2. Individual service periods: Specify start_date and end_date for each line item.\n When using this mode, ALL line items must have individual periods specified.\n\n3. Default behavior: If no service periods are specified (neither global nor individual),\n the original invoice line item service periods will be used.\n\nNote: Mixing global and individual service periods in the same request is not allowed\nto prevent confusion.\n\nService period dates are normalized to the start of the day in the customer's timezone to ensure\nconsistent handling across different timezones.\n\nDate Format: Use start_date and end_date with format \"YYYY-MM-DD\" (e.g., \"2023-09-22\")\nto match other Orb APIs like /v1/invoice_line_items.\n\nNote: Both start_date and end_date are inclusive - the service period will cover both\nthe start date and end date completely (from start of start_date to end of end_date).",
"operationId": "create-credit-note",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateCreditNoteParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/credit_notes/{credit_note_id}": {
"get": {
"tags": [
"Credit note"
],
"summary": "Fetch credit note",
"description": "This endpoint is used to fetch a single [`Credit Note`](/invoicing/credit-notes) given an identifier.",
"operationId": "fetch-credit-note",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "credit_note_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditNote"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers": {
"get": {
"tags": [
"Customer"
],
"summary": "List customers",
"description": "This endpoint returns a list of all customers for an account.\nThe list of customers is ordered starting from the most recently created customer.\nThis endpoint follows Orb's [standardized pagination format](/api-reference/pagination).\n\nSee [Customer](/core-concepts##customer) for an overview of the customer model.",
"operationId": "list-customers",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customers"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create customer",
"description": "This operation is used to create an Orb customer, who is party to the core billing relationship. See\n[Customer](/core-concepts##customer) for an overview of the customer resource.\n\nThis endpoint is critical in the following Orb functionality:\n* Automated charges can be configured by setting `payment_provider` and `payment_provider_id` to automatically\n issue invoices\n* [Customer ID Aliases](/events-and-metrics/customer-aliases) can be configured by setting\n `external_customer_id`\n* [Timezone localization](/essentials/timezones) can be configured on a per-customer basis by\n setting the `timezone` parameter",
"operationId": "create-customer",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewCustomer"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetch customer by external ID",
"description": "This endpoint is used to fetch customer details given an `external_customer_id` (see\n[Customer ID Aliases](/events-and-metrics/customer-aliases)).\n\nNote that the resource and semantics of this endpoint exactly mirror [Get Customer](fetch-customer).",
"operationId": "fetch-customer-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_customer_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update customer by external ID",
"description": "This endpoint is used to update customer details given an `external_customer_id`\n(see [Customer ID Aliases](/events-and-metrics/customer-aliases)).\nNote that the resource and semantics of this endpoint exactly mirror [Update Customer](update-customer).",
"operationId": "update-customer-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditCustomer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/costs": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetch customer costs by external ID",
"description": "This endpoint is used to fetch a day-by-day snapshot of a customer's costs in Orb, calculated by applying pricing\ninformation to the underlying usage (see the [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)\nto fetch usage per metric, in usage units rather than a currency).\n\nThis endpoint can be leveraged for internal tooling and to provide a more transparent billing experience for your\nend users:\n\n1. Understand the cost breakdown per line item historically and in real-time for the current billing period.\n2. Provide customer visibility into how different services are contributing to the overall invoice with a per-day\n timeseries (as compared to the [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,\n which represents a snapshot for the current period).\n3. Assess how minimums and discounts affect your customers by teasing apart costs directly as a result of usage,\n as opposed to minimums and discounts at the plan and price level.\n4. Gain insight into key customer health metrics, such as the percent utilization of the minimum committed spend.\n\n## Fetching subscriptions\nBy default, this endpoint fetches the currently active subscription for the customer, and returns cost information\nfor the subscription's current billing period, broken down by each participating price. If there are no currently\nactive subscriptions, this will instead default to the most recently active subscription or return an empty series\nif none are found. For example, if your plan charges for compute hours, job runs, and data syncs, then this endpoint\nwould provide a daily breakdown of your customer's cost for each of those axes.\n\nIf timeframe bounds are specified, Orb fetches all subscriptions that were active in that timeframe. If two\nsubscriptions overlap on a single day, costs from each price will be summed, and prices for both subscriptions will\nbe included in the breakdown.\n\n## Prepaid plans\nFor plans that include prices which deduct credits rather than accrue in-arrears charges in a billable currency,\nthis endpoint will return the total deduction amount, in credits, for the specified timeframe.\n\n## Cumulative subtotals and totals\nSince the subtotal and total must factor in any billing-period level discounts and minimums, it's most meaningful\nto consider costs relative to the start of the subscription's billing period. As a result, by default this endpoint\nreturns cumulative totals since the beginning of the billing period. In particular, the `timeframe_start` of a\nreturned timeframe window is *always* the beginning of the billing period and `timeframe_end` is incremented one day\nat a time to build the result.\n\nA customer that uses a few API calls a day but has a minimum commitment might exhibit the following pattern for\ntheir subtotal and total in the first few days of the month. Here, we assume that each API call is \\$2.50, the\ncustomer's plan has a monthly minimum of \\$50 for this price, and that the subscription's billing period bounds are\naligned to the first of the month:\n\n| timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |\n| -----------| ----------- | ----------- | ----------- |----------- |\n| 2023-02-01 | 2023-02-02 | 9 | \\$22.50 | \\$50.00 |\n| 2023-02-01 | 2023-02-03 | 19 | \\$47.50 | \\$50.00 |\n| 2023-02-01 | 2023-02-04 | 20 | \\$50.00 | \\$50.00 |\n| 2023-02-01 | 2023-02-05 | 28 | \\$70.00 | \\$70.00 |\n| 2023-02-01 | 2023-02-06 | 36 | \\$90.00 | \\$90.00 |\n\n### Periodic values\nWhen the query parameter `view_mode=periodic` is specified, Orb will return an incremental day-by-day view of costs.\nIn this case, there will always be a one-day difference between `timeframe_start` and `timeframe_end` for the\ntimeframes returned. This is a transform on top of the cumulative costs, calculated by taking the difference of each\ntimeframe with the last. Note that in the above example, the `Total` value would be 0 for the second two data\npoints, since the minimum commitment has not yet been hit and each day is not contributing anything to the total\ncost.\n\n## Timeframe bounds\nFor an active subscription, both timeframes should be specified in the request. If a subscription starts or ends within the\ntimeframe, the response will only include windows where the subscription is active. If a subscription has ended, no timeframe\nbounds need to be specified and the response will default to the billing period when the subscription was last active.\n\nAs noted above, `timeframe_start` for a given cumulative datapoint is always the beginning of the billing period,\nand `timeframe_end` is incremented one day at a time to construct the response. When a timeframe is passed in that\nis not aligned to the current subscription's billing period, the response will contain cumulative totals from\nmultiple billing periods.\n\nSuppose the queried customer has a subscription aligned to the 15th of every month. If this endpoint is queried with\nthe date range `2023-06-01` - `2023-07-01`, the first data point will represent about half a billing period's worth\nof costs, accounting for accruals from the start of the billing period and inclusive of the first day of the\ntimeframe (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`)\n\n| datapoint index | timeframe_start | timeframe_end |\n| ----------- | -----------| ----------- |\n| 0 | 2023-05-15 | 2023-06-02 |\n| 1 | 2023-05-15 | 2023-06-03 |\n| 2 | ... | ... |\n| 3 | 2023-05-15 | 2023-06-14 |\n| 4 | 2023-06-15 | 2023-06-16 |\n| 5 | 2023-06-15 | 2023-06-17 |\n| 6 | ... | ... |\n| 7 | 2023-06-15 | 2023-07-01 |\n\nYou can see this sliced timeframe visualized [here](https://i.imgur.com/TXhYgme.png).\n\n### Matrix prices\nWhen a price uses matrix pricing, it's important to view costs grouped by those matrix dimensions. Orb will return\n`price_groups` with the `grouping_key` and `secondary_grouping_key` based on the matrix price definition, for each\n`grouping_value` and `secondary_grouping_value` available.",
"operationId": "fetch-customer-costs-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Costs returned are inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"name": "timeframe_start",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Costs returned are exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"name": "timeframe_end",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"name": "view_mode",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCosts"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/credits": {
"get": {
"tags": [
"Credit"
],
"summary": "Fetch customer credit balance by external customer id",
"description": "Returns a paginated list of unexpired, non-zero credit blocks for a customer.\n\nIf `include_all_blocks` is set to `true`, all credit blocks (including expired and depleted blocks) will be included in\nthe response.\n\nNote that `currency` defaults to credits if not specified. To use a real world currency, set `currency` to an ISO 4217 string.\n\nResults can be filtered by the block's `effective_date` using the `effective_date[gte]`, `effective_date[gt]`,\n`effective_date[lt]`, and `effective_date[lte]` query parameters. This filters on when the credit block\nbecomes effective, which may differ from creation time for backdated credits.",
"operationId": "fetch-customer-credits-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "boolean",
"title": "Include All Blocks",
"description": "If set to True, all expired and depleted blocks, as well as active block will be returned.",
"default": false
},
"name": "include_all_blocks",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gte]"
},
"name": "effective_date[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gt]"
},
"name": "effective_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lt]"
},
"name": "effective_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lte]"
},
"name": "effective_date[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCreditBalances"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/credits/ledger": {
"get": {
"tags": [
"Credit"
],
"summary": "Fetch customer credits ledger by external ID",
"description": "The credits ledger provides _auditing_ functionality over Orb's credits system with a list of actions that have\ntaken place to modify a customer's credit balance. This [paginated endpoint](/api-reference/pagination) lists these\nentries, starting from the most recent ledger entry.\n\nMore details on using Orb's real-time credit feature are [here](/product-catalog/prepurchase).\n\nThere are four major types of modifications to credit balance, detailed below.\n\n## Increment\nCredits (which optionally expire on a future date) can be added via the API\n([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action will always contain the total\neligible starting and ending balance for the customer at the time the entry was added to the ledger.\n\n## Decrement\nDeductions can occur as a result of an API call to create a ledger entry (see\n[Add Ledger Entry](create-ledger-entry)), or automatically as a result of incurring usage. Both ledger entries\npresent the `decrement` entry type.\n\nAs usage for a customer is reported into Orb, credits may be deducted according to the customer's plan\nconfiguration. An automated deduction of this type will result in a ledger entry, also with a starting and ending\nbalance. Each day's usage for a particular price, invoice, and block will be grouped into a single entry.\n\nBy default, Orb uses an algorithm that automatically deducts from the *soonest expiring credit block* first in\norder to ensure that all credits are utilized appropriately. As an example, if trial credits with an expiration date\nof 2 weeks from now are present for a customer, they will be used before any deductions take place from a\nnon-expiring credit block.\n\nIf there are multiple blocks with the same expiration date, Orb will deduct from the block with the\n*lower cost basis* first (e.g. trial credits with a \\$0 cost basis before paid credits with a \\$5.00 cost basis).\n\nIt's also possible for a single usage event's deduction to _span_ credit blocks. In this case, Orb will deduct from\nthe next block, ending at the credit block which consists of unexpiring credits. Each of these deductions will lead\nto a _separate_ ledger entry, one per credit block that is deducted from. By default, the customer's total credit\nbalance in Orb can be negative as a result of a decrement.\n\n## Expiration change\nThe expiry of credits can be changed as a result of the API (See [Add Ledger Entry](create-ledger-entry)). This will\ncreate a ledger entry that specifies the balance as well as the initial and target expiry dates.\n\nNote that for this entry type, `starting_balance` will equal `ending_balance`, and the `amount` represents the\nbalance transferred. The credit block linked to the ledger entry is the source credit block from which there was an\nexpiration change.\n\n## Credits expiry\nWhen a set of credits expire on pre-set expiration date, the customer's balance automatically reflects this change\nand adds an entry to the ledger indicating this event. Note that credit expiry should always happen close to a date\nboundary in the customer's timezone.\n\n## Void initiated\nCredit blocks can be voided via the API. The `amount` on this entry corresponds to the number of credits that were\nremaining in the block at time of void. `void_reason` will be populated if the void is created with a reason.\n\n## Void\nWhen a set of credits is voided, the customer's balance automatically reflects this change and adds an entry to the\nledger indicating this event.\n\n## Amendment\nWhen credits are added to a customer's balance as a result of a correction, this entry will be added to the ledger\nto indicate the adjustment of credits.",
"operationId": "fetch-customer-credits-ledger-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 500.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"name": "minimum_amount",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"increment",
"decrement",
"expiration_change",
"credit_block_expiry",
"void",
"void_initiated",
"amendment"
]
},
{
"type": "null"
}
],
"title": "Entry Type"
},
"name": "entry_type",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"committed",
"pending"
]
},
{
"type": "null"
}
],
"title": "Entry Status"
},
"name": "entry_status",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditLedgerEntries"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/credits/ledger_entry": {
"post": {
"tags": [
"Credit"
],
"summary": "Create ledger entry by external ID",
"description": "This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to\nincrement balance, deduct credits, and change the expiry date of existing credits.\n\n## Effects of adding a ledger entry\n1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that\n represents the changes (i.e. balance changes or transfers).\n2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the\n [View Credits Ledger](fetch-customer-credits-ledger) response as well as serialized in the response to this request. In\n the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans\n credit blocks.\n3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on\n `amount` and `per_unit_cost_basis`).\n\n## Adding credits\n Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of\n credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description\n to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate\n how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.\n\nThe following snippet illustrates a sample request body to increment credits which will expire in January of 2022.\n\n```json\n{\n \"entry_type\": \"increment\",\n \"amount\": 100,\n \"expiry_date\": \"2022-12-28\",\n \"per_unit_cost_basis\": \"0.20\",\n \"description\": \"Purchased 100 credits\"\n}\n```\n\nNote that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the\nremaining amount to the desired credit block.\n\n### Invoicing for credits\nBy default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass\n`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the\ncredits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the\ninvoice are calculated by multiplying the cost basis with the number of credit units added. If you invoice or handle payment\nof credits outside of Orb (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to `true` to prevent\nduplicate invoicing effects.\n* if `per_unit_cost_basis` is greater than zero, an invoice will be generated and `invoice_settings` must be included\n* if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required to determine the due date\n\n## Deducting Credits\nOrb allows you to deduct credits from a customer by creating an entry of type `decrement`. A `decrement` entry\nrecords credits as usage and immediately recognizes revenue at the block's `per_unit_cost_basis`.\n\nFor most credit removals, use `void` (no revenue impact) or `expiration_change` (revenue recognized on expiration)\ninstead. Only use `decrement` when credits were genuinely consumed outside of normal event ingestion.\n\nOrb matches the algorithm for automatic deductions for determining which credit blocks to decrement from. In the\ncase that the deduction leads to multiple ledger entries, the response from this endpoint will be the final\ndeduction. Orb also optionally allows specifying a description to assist with auditing.\n\nThe following snippet illustrates a sample request body to decrement credits.\n\n```json\n{\n \"entry_type\": \"decrement\",\n \"amount\": 20,\n \"description\": \"Removing excess credits\"\n}\n```\n\n## Changing credits expiry\nIf you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.\nFor this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter\n`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created\nwith expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.\n\nNote that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer\namount determined by the `amount` parameter.\n\nThe following snippet illustrates a sample request body to extend the expiration date of credits by one year:\n\n```json\n{\n \"entry_type\": \"expiration_change\",\n \"amount\": 10,\n \"expiry_date\": \"2022-12-28\",\n \"block_id\": \"UiUhFWeLHPrBY4Ad\",\n \"target_expiry_date\": \"2023-12-28\",\n \"description\": \"Extending credit validity\"\n}\n```\n\n## Voiding credits\n\nIf you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required\nto identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass\nin a `void_reason` of `refund` if the void is due to a refund.\n\n## Amendment\n\nIf you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`\nis required to identify the block that was originally decremented from, and `amount` indicates how many credits to return\nto the customer, up to the block's initial balance.",
"operationId": "create-ledger-entry-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCreditLedgerEntryRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditLedgerEntry"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/credits/top_ups": {
"get": {
"tags": [
"Credit"
],
"summary": "List top-ups by external ID",
"operationId": "list-top-ups-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUps"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Credit"
],
"summary": "Create top-up by external ID",
"description": "This endpoint allows you to create a new top-up for a specified customer's balance.\nWhile this top-up is active, the customer's balance will added in increments of\nthe specified amount whenever the balance reaches the specified threshold.\n\nIf a top-up already exists for this customer in the same currency,\nthe existing top-up will be replaced.",
"operationId": "create-top-up-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCreditTopUpRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUp"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/credits/top_ups/{top_up_id}": {
"delete": {
"tags": [
"Credit"
],
"summary": "Deactivate top-up by external ID",
"description": "This deactivates the top-up and voids any invoices associated with pending credit blocks purchased through the top-up.",
"operationId": "delete-top-up-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "top_up_id",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/portal_sessions": {
"post": {
"tags": [
"Customer"
],
"summary": "Create portal session by external ID",
"description": "Creates a portal session for the customer, returning a short-lived URL that provides\nauthenticated access to the customer's billing portal. The session expires after\n`expires_in_minutes` (default 60, max 180). By default, creating a new session invalidates\nany other active portal sessions for the customer; pass `invalidate_existing=false` to\nallow concurrent sessions.",
"operationId": "create-customer-portal-session-by-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPortalSession"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortalSession"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/external_customer_id/{external_customer_id}/sync_payment_methods_from_gateway": {
"post": {
"tags": [
"Customer"
],
"summary": "Update payment methods from payment provider",
"description": "Sync Orb's payment methods for the customer with their gateway.\n\nThis method can be called before taking an action that may cause the customer to be charged, ensuring that the most up-to-date\npayment method is charged.\n\n**Note**: This functionality is currently only available for Stripe.",
"operationId": "sync-customer-payment-methods-from-gateway-by-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_customer_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetch customer",
"description": "This endpoint is used to fetch customer details given an identifier. If the `Customer` is in the process of being deleted,\nonly the properties `id` and `deleted: true` will be returned.\n\nSee the [Customer resource](/core-concepts#customer) for a full discussion of the Customer model.",
"operationId": "fetch-customer",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "customer_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Customer"
],
"summary": "Update customer",
"description": "This endpoint can be used to update the `payment_provider`, `payment_provider_id`, `name`, `email`, `email_delivery`, `tax_id`,\n`auto_collection`, `metadata`, `shipping_address`, `billing_address`, `additional_emails`, and `currency` of an existing\ncustomer. `currency` can only be set if it has not already been set on the customer. Other fields on a customer are currently\nimmutable.",
"operationId": "update-customer",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditCustomer"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"delete": {
"tags": [
"Customer"
],
"summary": "Delete customer",
"description": "This performs a deletion of this customer, its subscriptions, and its invoices, provided the customer does not have any issued\ninvoices. Customers with issued invoices cannot be deleted. This operation is irreversible. Note that this\nis a _soft_ deletion, but the data will be inaccessible through the API and Orb dashboard.\n\nFor a hard-deletion, please reach out to the Orb team directly.\n\n**Note**: This operation happens asynchronously and can be expected to take a\nfew minutes to propagate to related resources. However, querying for the customer on\nsubsequent GET requests while deletion is in process will reflect its deletion.",
"operationId": "delete-customer",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "customer_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/balance_transactions": {
"get": {
"tags": [
"Customer"
],
"summary": "List balance transactions",
"description": "## The customer balance\n\nThe customer balance is an amount in the customer's currency, which Orb automatically applies to subsequent\ninvoices. This balance can be adjusted manually via Orb's webapp on the customer details page. You can use this\nbalance to provide a fixed mid-period credit to the customer. Commonly, this is done due to system downtime/SLA\nviolation, or an adhoc adjustment discussed with the customer.\n\nIf the balance is a positive value at the time of invoicing, it represents that the customer has credit that should\nbe used to offset the amount due on the next issued invoice. In this case, Orb will automatically reduce the next\ninvoice by the balance amount, and roll over any remaining balance if the invoice is fully discounted.\n\nIf the balance is a negative value at the time of invoicing, Orb will increase the invoice's amount due with a\npositive adjustment, and reset the balance to 0.\n\nThis endpoint retrieves all customer balance transactions in reverse chronological order for a single customer,\nproviding a complete audit trail of all adjustments and invoice applications.",
"operationId": "list-balance-transactions",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Gte]"
},
"name": "operation_time[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Gt]"
},
"name": "operation_time[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Lt]"
},
"name": "operation_time[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Lte]"
},
"name": "operation_time[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerBalanceTransactions"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Customer"
],
"summary": "Create customer balance transaction",
"description": "Creates an immutable balance transaction that updates the customer's balance and returns back the newly created\ntransaction.",
"operationId": "create-customer-balance-transaction",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewCustomerBalanceTransaction"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/costs": {
"get": {
"tags": [
"Customer"
],
"summary": "Fetch customer costs",
"description": "This endpoint is used to fetch a day-by-day snapshot of a customer's costs in Orb, calculated by applying pricing\ninformation to the underlying usage (see the [subscription usage endpoint](/api-reference/subscription/fetch-subscription-usage)\nto fetch usage per metric, in usage units rather than a currency).\n\nThis endpoint can be leveraged for internal tooling and to provide a more transparent billing experience for your\nend users:\n\n1. Understand the cost breakdown per line item historically and in real-time for the current billing period.\n2. Provide customer visibility into how different services are contributing to the overall invoice with a per-day\n timeseries (as compared to the [upcoming invoice](/api-reference/invoice/fetch-upcoming-invoice) resource,\n which represents a snapshot for the current period).\n3. Assess how minimums and discounts affect your customers by teasing apart costs directly as a result of usage,\n as opposed to minimums and discounts at the plan and price level.\n4. Gain insight into key customer health metrics, such as the percent utilization of the minimum committed spend.\n\n## Fetching subscriptions\nBy default, this endpoint fetches the currently active subscription for the customer, and returns cost information\nfor the subscription's current billing period, broken down by each participating price. If there are no currently\nactive subscriptions, this will instead default to the most recently active subscription or return an empty series\nif none are found. For example, if your plan charges for compute hours, job runs, and data syncs, then this endpoint\nwould provide a daily breakdown of your customer's cost for each of those axes.\n\nIf timeframe bounds are specified, Orb fetches all subscriptions that were active in that timeframe. If two\nsubscriptions overlap on a single day, costs from each price will be summed, and prices for both subscriptions will\nbe included in the breakdown.\n\n## Prepaid plans\nFor plans that include prices which deduct credits rather than accrue in-arrears charges in a billable currency,\nthis endpoint will return the total deduction amount, in credits, for the specified timeframe.\n\n## Cumulative subtotals and totals\nSince the subtotal and total must factor in any billing-period level discounts and minimums, it's most meaningful\nto consider costs relative to the start of the subscription's billing period. As a result, by default this endpoint\nreturns cumulative totals since the beginning of the billing period. In particular, the `timeframe_start` of a\nreturned timeframe window is *always* the beginning of the billing period and `timeframe_end` is incremented one day\nat a time to build the result.\n\nA customer that uses a few API calls a day but has a minimum commitment might exhibit the following pattern for\ntheir subtotal and total in the first few days of the month. Here, we assume that each API call is \\$2.50, the\ncustomer's plan has a monthly minimum of \\$50 for this price, and that the subscription's billing period bounds are\naligned to the first of the month:\n\n| timeframe_start | timeframe_end | Cumulative usage | Subtotal | Total (incl. commitment) |\n| -----------| ----------- | ----------- | ----------- |----------- |\n| 2023-02-01 | 2023-02-02 | 9 | \\$22.50 | \\$50.00 |\n| 2023-02-01 | 2023-02-03 | 19 | \\$47.50 | \\$50.00 |\n| 2023-02-01 | 2023-02-04 | 20 | \\$50.00 | \\$50.00 |\n| 2023-02-01 | 2023-02-05 | 28 | \\$70.00 | \\$70.00 |\n| 2023-02-01 | 2023-02-06 | 36 | \\$90.00 | \\$90.00 |\n\n### Periodic values\nWhen the query parameter `view_mode=periodic` is specified, Orb will return an incremental day-by-day view of costs.\nIn this case, there will always be a one-day difference between `timeframe_start` and `timeframe_end` for the\ntimeframes returned. This is a transform on top of the cumulative costs, calculated by taking the difference of each\ntimeframe with the last. Note that in the above example, the `Total` value would be 0 for the second two data\npoints, since the minimum commitment has not yet been hit and each day is not contributing anything to the total\ncost.\n\n## Timeframe bounds\nFor an active subscription, both timeframes should be specified in the request. If a subscription starts or ends within the\ntimeframe, the response will only include windows where the subscription is active. If a subscription has ended, no timeframe\nbounds need to be specified and the response will default to the billing period when the subscription was last active.\n\nAs noted above, `timeframe_start` for a given cumulative datapoint is always the beginning of the billing period,\nand `timeframe_end` is incremented one day at a time to construct the response. When a timeframe is passed in that\nis not aligned to the current subscription's billing period, the response will contain cumulative totals from\nmultiple billing periods.\n\nSuppose the queried customer has a subscription aligned to the 15th of every month. If this endpoint is queried with\nthe date range `2023-06-01` - `2023-07-01`, the first data point will represent about half a billing period's worth\nof costs, accounting for accruals from the start of the billing period and inclusive of the first day of the\ntimeframe (`timeframe_start = 2023-05-15 00:00:00`, `timeframe_end = 2023-06-02 00:00:00`)\n\n| datapoint index | timeframe_start | timeframe_end |\n| ----------- | -----------| ----------- |\n| 0 | 2023-05-15 | 2023-06-02 |\n| 1 | 2023-05-15 | 2023-06-03 |\n| 2 | ... | ... |\n| 3 | 2023-05-15 | 2023-06-14 |\n| 4 | 2023-06-15 | 2023-06-16 |\n| 5 | 2023-06-15 | 2023-06-17 |\n| 6 | ... | ... |\n| 7 | 2023-06-15 | 2023-07-01 |\n\nYou can see this sliced timeframe visualized [here](https://i.imgur.com/TXhYgme.png).\n\n### Matrix prices\nWhen a price uses matrix pricing, it's important to view costs grouped by those matrix dimensions. Orb will return\n`price_groups` with the `grouping_key` and `secondary_grouping_key` based on the matrix price definition, for each\n`grouping_value` and `secondary_grouping_value` available.",
"operationId": "fetch-customer-costs",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Costs returned are inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"name": "timeframe_start",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Costs returned are exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"name": "timeframe_end",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"name": "view_mode",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCosts"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/credits": {
"get": {
"tags": [
"Credit"
],
"summary": "Fetch customer credit balance",
"description": "Returns a paginated list of unexpired, non-zero credit blocks for a customer.\n\nIf `include_all_blocks` is set to `true`, all credit blocks (including expired and depleted blocks) will be included in\nthe response.\n\nNote that `currency` defaults to credits if not specified. To use a real world currency, set `currency` to an ISO 4217 string.\n\nResults can be filtered by the block's `effective_date` using the `effective_date[gte]`, `effective_date[gt]`,\n`effective_date[lt]`, and `effective_date[lte]` query parameters. This filters on when the credit block\nbecomes effective, which may differ from creation time for backdated credits.",
"operationId": "fetch-customer-credits",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "boolean",
"title": "Include All Blocks",
"description": "If set to True, all expired and depleted blocks, as well as active block will be returned.",
"default": false
},
"name": "include_all_blocks",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gte]"
},
"name": "effective_date[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gt]"
},
"name": "effective_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lt]"
},
"name": "effective_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lte]"
},
"name": "effective_date[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CustomerCreditBalances"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/credits/ledger": {
"get": {
"tags": [
"Credit"
],
"summary": "Fetch customer credits ledger",
"description": "The credits ledger provides _auditing_ functionality over Orb's credits system with a list of actions that have\ntaken place to modify a customer's credit balance. This [paginated endpoint](/api-reference/pagination) lists these\nentries, starting from the most recent ledger entry.\n\nMore details on using Orb's real-time credit feature are [here](/product-catalog/prepurchase).\n\nThere are four major types of modifications to credit balance, detailed below.\n\n## Increment\nCredits (which optionally expire on a future date) can be added via the API\n([Add Ledger Entry](create-ledger-entry)). The ledger entry for such an action will always contain the total\neligible starting and ending balance for the customer at the time the entry was added to the ledger.\n\n## Decrement\nDeductions can occur as a result of an API call to create a ledger entry (see\n[Add Ledger Entry](create-ledger-entry)), or automatically as a result of incurring usage. Both ledger entries\npresent the `decrement` entry type.\n\nAs usage for a customer is reported into Orb, credits may be deducted according to the customer's plan\nconfiguration. An automated deduction of this type will result in a ledger entry, also with a starting and ending\nbalance. Each day's usage for a particular price, invoice, and block will be grouped into a single entry.\n\nBy default, Orb uses an algorithm that automatically deducts from the *soonest expiring credit block* first in\norder to ensure that all credits are utilized appropriately. As an example, if trial credits with an expiration date\nof 2 weeks from now are present for a customer, they will be used before any deductions take place from a\nnon-expiring credit block.\n\nIf there are multiple blocks with the same expiration date, Orb will deduct from the block with the\n*lower cost basis* first (e.g. trial credits with a \\$0 cost basis before paid credits with a \\$5.00 cost basis).\n\nIt's also possible for a single usage event's deduction to _span_ credit blocks. In this case, Orb will deduct from\nthe next block, ending at the credit block which consists of unexpiring credits. Each of these deductions will lead\nto a _separate_ ledger entry, one per credit block that is deducted from. By default, the customer's total credit\nbalance in Orb can be negative as a result of a decrement.\n\n## Expiration change\nThe expiry of credits can be changed as a result of the API (See [Add Ledger Entry](create-ledger-entry)). This will\ncreate a ledger entry that specifies the balance as well as the initial and target expiry dates.\n\nNote that for this entry type, `starting_balance` will equal `ending_balance`, and the `amount` represents the\nbalance transferred. The credit block linked to the ledger entry is the source credit block from which there was an\nexpiration change.\n\n## Credits expiry\nWhen a set of credits expire on pre-set expiration date, the customer's balance automatically reflects this change\nand adds an entry to the ledger indicating this event. Note that credit expiry should always happen close to a date\nboundary in the customer's timezone.\n\n## Void initiated\nCredit blocks can be voided via the API. The `amount` on this entry corresponds to the number of credits that were\nremaining in the block at time of void. `void_reason` will be populated if the void is created with a reason.\n\n## Void\nWhen a set of credits is voided, the customer's balance automatically reflects this change and adds an entry to the\nledger indicating this event.\n\n## Amendment\nWhen credits are added to a customer's balance as a result of a correction, this entry will be added to the ledger\nto indicate the adjustment of credits.",
"operationId": "fetch-customer-credits-ledger",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 500.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"name": "minimum_amount",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"increment",
"decrement",
"expiration_change",
"credit_block_expiry",
"void",
"void_initiated",
"amendment"
]
},
{
"type": "null"
}
],
"title": "Entry Type"
},
"name": "entry_type",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"committed",
"pending"
]
},
{
"type": "null"
}
],
"title": "Entry Status"
},
"name": "entry_status",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditLedgerEntries"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/credits/ledger_entry": {
"post": {
"tags": [
"Credit"
],
"summary": "Create ledger entry",
"description": "This endpoint allows you to create a new ledger entry for a specified customer's balance. This can be used to\nincrement balance, deduct credits, and change the expiry date of existing credits.\n\n## Effects of adding a ledger entry\n1. After calling this endpoint, [Fetch Credit Balance](fetch-customer-credits) will return a credit block that\n represents the changes (i.e. balance changes or transfers).\n2. A ledger entry will be added to the credits ledger for this customer, and therefore returned in the\n [View Credits Ledger](fetch-customer-credits-ledger) response as well as serialized in the response to this request. In\n the case of deductions without a specified block, multiple ledger entries may be created if the deduction spans\n credit blocks.\n3. If `invoice_settings` is specified, an invoice will be created that reflects the cost of the credits (based on\n `amount` and `per_unit_cost_basis`).\n\n## Adding credits\n Adding credits is done by creating an entry of type `increment`. This requires the caller to specify a number of\n credits as well as an optional expiry date in `YYYY-MM-DD` format. Orb also recommends specifying a description\n to assist with auditing. When adding credits, the caller can also specify a cost basis per-credit, to indicate\n how much in USD a customer paid for a single credit in a block. This can later be used for revenue recognition.\n\nThe following snippet illustrates a sample request body to increment credits which will expire in January of 2022.\n\n```json\n{\n \"entry_type\": \"increment\",\n \"amount\": 100,\n \"expiry_date\": \"2022-12-28\",\n \"per_unit_cost_basis\": \"0.20\",\n \"description\": \"Purchased 100 credits\"\n}\n```\n\nNote that by default, Orb will always first increment any _negative_ balance in existing blocks before adding the\nremaining amount to the desired credit block.\n\n### Invoicing for credits\nBy default, Orb manipulates the credit ledger but does not charge for credits. However, if you pass\n`invoice_settings` in the body of this request, Orb will also generate a one-off invoice for the customer for the\ncredits pre-purchase. Note that you _must_ provide the `per_unit_cost_basis`, since the total charges on the\ninvoice are calculated by multiplying the cost basis with the number of credit units added. If you invoice or handle payment\nof credits outside of Orb (i.e. marketplace customers), set `mark_as_paid` in the `invoice_settings` to `true` to prevent\nduplicate invoicing effects.\n* if `per_unit_cost_basis` is greater than zero, an invoice will be generated and `invoice_settings` must be included\n* if `invoice_settings` is passed, one of either `custom_due_date` or `net_terms` is required to determine the due date\n\n## Deducting Credits\nOrb allows you to deduct credits from a customer by creating an entry of type `decrement`. A `decrement` entry\nrecords credits as usage and immediately recognizes revenue at the block's `per_unit_cost_basis`.\n\nFor most credit removals, use `void` (no revenue impact) or `expiration_change` (revenue recognized on expiration)\ninstead. Only use `decrement` when credits were genuinely consumed outside of normal event ingestion.\n\nOrb matches the algorithm for automatic deductions for determining which credit blocks to decrement from. In the\ncase that the deduction leads to multiple ledger entries, the response from this endpoint will be the final\ndeduction. Orb also optionally allows specifying a description to assist with auditing.\n\nThe following snippet illustrates a sample request body to decrement credits.\n\n```json\n{\n \"entry_type\": \"decrement\",\n \"amount\": 20,\n \"description\": \"Removing excess credits\"\n}\n```\n\n## Changing credits expiry\nIf you'd like to change when existing credits expire, you should create a ledger entry of type `expiration_change`.\nFor this entry, the required parameter `expiry_date` identifies the _originating_ block, and the required parameter\n`target_expiry_date` identifies when the transferred credits should now expire. A new credit block will be created\nwith expiry date `target_expiry_date`, with the same cost basis data as the original credit block, if present.\n\nNote that the balance of the block with the given `expiry_date` must be at least equal to the desired transfer\namount determined by the `amount` parameter.\n\nThe following snippet illustrates a sample request body to extend the expiration date of credits by one year:\n\n```json\n{\n \"entry_type\": \"expiration_change\",\n \"amount\": 10,\n \"expiry_date\": \"2022-12-28\",\n \"block_id\": \"UiUhFWeLHPrBY4Ad\",\n \"target_expiry_date\": \"2023-12-28\",\n \"description\": \"Extending credit validity\"\n}\n```\n\n## Voiding credits\n\nIf you'd like to void a credit block, create a ledger entry of type `void`. For this entry, `block_id` is required\nto identify the block, and `amount` indicates how many credits to void, up to the block's initial balance. Pass\nin a `void_reason` of `refund` if the void is due to a refund.\n\n## Amendment\n\nIf you'd like to undo a decrement on a credit block, create a ledger entry of type `amendment`. For this entry, `block_id`\nis required to identify the block that was originally decremented from, and `amount` indicates how many credits to return\nto the customer, up to the block's initial balance.",
"operationId": "create-ledger-entry",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCreditLedgerEntryRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreditLedgerEntry"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/credits/top_ups": {
"get": {
"tags": [
"Credit"
],
"summary": "List top-ups",
"operationId": "list-top-ups",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUps"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Credit"
],
"summary": "Create top-up",
"description": "This endpoint allows you to create a new top-up for a specified customer's balance.\nWhile this top-up is active, the customer's balance will added in increments of\nthe specified amount whenever the balance reaches the specified threshold.\n\nIf a top-up already exists for this customer in the same currency,\nthe existing top-up will be replaced.",
"operationId": "create-top-up",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddCreditTopUpRequestParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TopUp"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/credits/top_ups/{top_up_id}": {
"delete": {
"tags": [
"Credit"
],
"summary": "Deactivate top-up",
"description": "This deactivates the top-up and voids any invoices associated with pending credit blocks purchased through the top-up.",
"operationId": "delete-top-up",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "top_up_id",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/portal_sessions": {
"post": {
"tags": [
"Customer"
],
"summary": "Create portal session",
"description": "Creates a portal session for the customer, returning a short-lived URL that provides\nauthenticated access to the customer's billing portal. The session expires after\n`expires_in_minutes` (default 60, max 180). By default, creating a new session invalidates\nany other active portal sessions for the customer; pass `invalidate_existing=false` to\nallow concurrent sessions.",
"operationId": "create-customer-portal-session",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPortalSession"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PortalSession"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/customers/{customer_id}/sync_payment_methods_from_gateway": {
"post": {
"tags": [
"Customer"
],
"summary": "Update payment methods from payment provider",
"description": "Sync Orb's payment methods for the customer with their gateway.\n\nThis method can be called before taking an action that may cause the customer to be charged, ensuring that the most up-to-date\npayment method is charged.\n\n**Note**: This functionality is currently only available for Stripe.",
"operationId": "sync-customer-payment-methods-from-gateway",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "customer_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/dimensional_price_groups": {
"get": {
"tags": [
"Dimensional Price Group"
],
"summary": "List dimensional price groups",
"operationId": "list-dimensional-price-groups",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroups"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Dimensional Price Group"
],
"summary": "Create dimensional price group",
"description": "A dimensional price group is used to partition the result of a billable metric by a set of dimensions. Prices in a\nprice group must specify the partition used to derive their usage.\n\nFor example, suppose we have a billable metric that measures the number of widgets used and we want to charge differently\ndepending on the color of the widget. We can create a price group with a dimension \"color\" and two prices: one that\ncharges \\$10 per red widget and one that charges \\$20 per blue widget.",
"operationId": "create-dimensional-price-group",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewDimensionalPriceGroup"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/dimensional_price_groups/external_dimensional_price_group_id/{external_dimensional_price_group_id}": {
"get": {
"tags": [
"Dimensional Price Group"
],
"summary": "Fetch dimensional price group by external ID",
"operationId": "fetch-dimensional-price-group-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_dimensional_price_group_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Dimensional Price Group"
],
"summary": "Update dimensional price group by external ID",
"description": "This endpoint can be used to update the `external_dimensional_price_group_id` and `metadata` of an existing\ndimensional price group. Other fields on a dimensional price group are currently immutable.",
"operationId": "update-dimensional-price-group-external",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_dimensional_price_group_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditDimensionalPriceGroup"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/dimensional_price_groups/{dimensional_price_group_id}": {
"get": {
"tags": [
"Dimensional Price Group"
],
"summary": "Fetch dimensional price group",
"operationId": "fetch-dimensional-price-group",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "dimensional_price_group_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Dimensional Price Group"
],
"summary": "Update dimensional price group",
"description": "This endpoint can be used to update the `external_dimensional_price_group_id` and `metadata` of an existing\ndimensional price group. Other fields on a dimensional price group are currently immutable.",
"operationId": "update-dimensional-price-group",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "dimensional_price_group_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditDimensionalPriceGroup"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/backfills": {
"get": {
"tags": [
"Event"
],
"summary": "List backfills",
"description": "This endpoint returns a list of all backfills in a list format.\n\nThe list of backfills is ordered starting from the most recently created backfill. The response also includes\n[`pagination_metadata`](/api-reference/pagination), which lets the caller retrieve the next page of results if they\nexist.",
"operationId": "list-backfills",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backfills"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Event"
],
"summary": "Create backfill",
"description": "Creating the backfill enables adding or replacing past events, even those that are older than the ingestion grace\nperiod. Performing a backfill in Orb involves 3 steps:\n\n1. Create the backfill, specifying its parameters.\n2. [Ingest](/api-reference/event/ingest-events) usage events, referencing the backfill (query parameter `backfill_id`).\n3. [Close](close-backfill) the\nbackfill, propagating the update in past usage throughout Orb.\n\nChanges from a backfill are not reflected until the\nbackfill is closed, so you won\u2019t need to worry about your customers seeing partially updated usage data. Backfills are\nalso reversible, so you\u2019ll be able to revert a backfill if you\u2019ve made a mistake.\n\nThis endpoint will return a\nbackfill object, which contains an `id`. That `id` can then be used as the `backfill_id` query parameter to the event\ningestion endpoint to associate ingested events with this backfill. The effects (e.g. updated usage graphs) of this\nbackfill will not take place until the backfill is closed.\n\nIf the `replace_existing_events` is `true`, existing\nevents in the backfill's timeframe will be replaced with the newly ingested events associated with the backfill. If\n`false`, newly ingested events will be added to the existing events.\n\nIf a `customer_id` or `external_customer_id` is specified, the backfill will only affect events for that customer.\nIf neither is specified, the backfill will affect all customers.\n\nWhen `replace_existing_events` is `true`, this indicates that existing events in the timeframe should no longer be counted\ntowards invoiced usage. In this scenario, the parameter `deprecation_filter` can be optionally added which enables filtering\nusing [computed properties](/extensibility/advanced-metrics#computed-properties). The expressiveness of computed properties\nallows you to deprecate existing events based on both a period of time and specific property values.\n\nYou may not have multiple backfills in a pending or pending_revert state with overlapping timeframes.",
"operationId": "create-backfill",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewBackfill"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backfill"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/backfills/{backfill_id}": {
"get": {
"tags": [
"Event"
],
"summary": "Fetch backfill",
"description": "This endpoint is used to fetch a backfill given an identifier.",
"operationId": "fetch-backfill",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "backfill_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backfill"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/backfills/{backfill_id}/close": {
"post": {
"tags": [
"Event"
],
"summary": "Close backfill",
"description": "Closing a backfill makes the updated usage visible in Orb. Upon closing a backfill, Orb will asynchronously reflect\nthe updated usage in invoice amounts and usage graphs. Once all of the updates are complete, the backfill's status\nwill transition to `reflected`.",
"operationId": "close-backfill",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "backfill_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backfill"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/backfills/{backfill_id}/revert": {
"post": {
"tags": [
"Event"
],
"summary": "Revert backfill",
"description": "Reverting a backfill undoes all the effects of closing the backfill. If the backfill is reflected, the status will\ntransition to `pending_revert` while the effects of the backfill are undone. Once all effects are undone, the\nbackfill will transition to `reverted`.\n\nIf a backfill is reverted before its closed, no usage will be updated as a result of the backfill and it will\nimmediately transition to `reverted`.",
"operationId": "revert-backfill",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "backfill_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Backfill"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/search": {
"post": {
"tags": [
"Event"
],
"summary": "Search events",
"description": "This endpoint returns a filtered set of events for an account in a [paginated list format](/api-reference/pagination).\n\nNote that this is a `POST` endpoint rather than a `GET` endpoint because it employs a JSON body for search criteria\nrather than query parameters, allowing for a more flexible search syntax.\n\nNote that a search criteria _must_ be specified. Currently, Orb supports the following criteria:\n- `event_ids`: This is an explicit array of IDs to filter by. Note that an event's ID is the `idempotency_key` that\n was originally used for ingestion.\n\nBy default, Orb will not throw a `404` if no events matched, Orb will return an empty array for `data` instead.",
"operationId": "search-events",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventSearchCriteria"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Events"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/volume": {
"get": {
"tags": [
"Event"
],
"summary": "Get event volume",
"description": "This endpoint returns the event volume for an account in a [paginated list format](/api-reference/pagination).\n\nThe event volume is aggregated by the hour and the [timestamp](/api-reference/event/ingest-events)\nfield is used to determine which hour an event is associated with. Note, this means that late-arriving events\nincrement the volume count for the hour window the timestamp is in, not the latest hour window.\n\nEach item in the response contains the count of events aggregated by the hour\nwhere the start and end time are hour-aligned and in UTC. When a specific timestamp is passed\nin for either start or end time, the response includes the hours the timestamp falls in.",
"operationId": "get-event-volume",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The start of the timeframe, inclusive, in which to return event volume. All datetime values are converted to UTC time. If the specified time isn't hour-aligned, the response includes the event volume count for the hour the time falls in."
},
"name": "timeframe_start",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The end of the timeframe, exclusive, in which to return event volume. If not specified, the current time is used. All datetime values are converted to UTC time.If the specified time isn't hour-aligned, the response includes the event volumecount for the hour the time falls in.",
"examples": [
"2024-10-11T06:00:00Z"
]
},
"name": "timeframe_end",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EventVolumes"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/{event_id}": {
"put": {
"tags": [
"Event"
],
"summary": "Amend event",
"description": "This endpoint is used to amend a single usage event with a given `event_id`. `event_id` refers to the\n`idempotency_key` passed in during ingestion. The event will maintain its existing `event_id` after the amendment.\n\nThis endpoint will mark the existing event as ignored, and Orb will only use the new event passed in the body of\nthis request as the source of truth for that `event_id`. Note that a single event can be amended any number of\ntimes, so the same event can be overwritten in subsequent calls to this endpoint. Only a single event with a given\n`event_id` will be considered the source of truth at any given time.\n\nThis is a powerful and audit-safe mechanism to retroactively update a single event in cases where you need to:\n* update an event with new metadata as you iterate on your pricing model\n* update an event based on the result of an external API call (e.g. call to a payment gateway succeeded or failed)\n\nThis amendment API is always audit-safe. The process will still retain the original event, though it will be\nignored for billing calculations. For auditing and data fidelity purposes, Orb never overwrites or permanently\ndeletes ingested usage data.\n\n## Request validation\n* The `timestamp` of the new event must match the `timestamp` of the existing event already ingested. As with\n ingestion, all timestamps must be sent in ISO8601 format with UTC timezone offset.\n* The `customer_id` or `external_customer_id` of the new event must match the `customer_id` or\n `external_customer_id` of the existing event already ingested. Exactly one of `customer_id` and\n `external_customer_id` should be specified, and similar to ingestion, the ID must identify a Customer resource\n within Orb. Unlike ingestion, for event amendment, we strictly enforce that the Customer must be in the Orb\n system, even during the initial integration period. We do not allow updating the `Customer` an event is\n associated with.\n* Orb does not accept an `idempotency_key` with the event in this endpoint, since this request is by design\n idempotent. On retryable errors, you should retry the request and assume the amendment operation has not\n succeeded until receipt of a 2xx.\n* The event's `timestamp` must fall within the customer's current subscription's billing period, or within the\n grace period of the customer's current subscription's previous billing period.\n* By default, no more than 100 events can be amended for a single customer in a 100 day period. For higher volume\n updates, consider using the [event backfill](create-backfill) endpoint.",
"operationId": "amend-event",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "event_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmendedEvent"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AmendEventResult"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/events/{event_id}/deprecate": {
"put": {
"tags": [
"Event"
],
"summary": "Deprecate event",
"description": "This endpoint is used to deprecate a single usage event with a given `event_id`. `event_id` refers to the\n`idempotency_key` passed in during ingestion.\n\nThis endpoint will mark the existing event as ignored. Note that if you attempt to re-ingest an event with the same\n`event_id` as a deprecated event, Orb will return an error.\n\nThis is a powerful and audit-safe mechanism to retroactively deprecate a single event in cases where you need to:\n* no longer bill for an event that was improperly reported\n* no longer bill for an event based on the result of an external API call (e.g. call to a payment gateway failed and\n the user should not be billed)\n\nIf you want to only change specific properties of an event, but keep the event as part of the billing calculation,\nuse the [Amend event](amend-event) endpoint instead.\n\nThis API is always audit-safe. The process will still retain the deprecated event, though it will be ignored for\nbilling calculations. For auditing and data fidelity purposes, Orb never overwrites or permanently deletes ingested\nusage data.\n\n## Request validation\n* Orb does not accept an `idempotency_key` with the event in this endpoint, since this request is by design\n idempotent. On retryable errors, you should retry the request and assume the deprecation operation has not\n succeeded until receipt of a 2xx.\n* The event's `timestamp` must fall within the customer's current subscription's billing period, or within the\n grace period of the customer's current subscription's previous billing period. Orb does not allow deprecating\n events for billing periods that have already invoiced customers.\n* The `customer_id` or the `external_customer_id` of the original event ingestion request must identify a Customer\n resource within Orb, even if this event was ingested during the initial integration period. We do not allow\n deprecating events for customers not in the Orb system.\n* By default, no more than 100 events can be deprecated for a single customer in a 100 day period. For higher volume\n updates, consider using the [event backfill](create-backfill) endpoint.",
"operationId": "deprecate-event",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "event_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeprecatedEventResult"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/ingest": {
"post": {
"tags": [
"Event"
],
"summary": "Ingest events",
"description": "Orb's event ingestion model and API is designed around two core principles:\n\n1. **Data fidelity**: The accuracy of your billing model depends on a robust foundation of events. Orb's API protocol\nencourages usage patterns that ensure that your data is consistently complete and correct.\n2. **Fast integration**: Sending events into Orb requires no tedious setup steps or explicit field schema for your event\nshape, making it instant to start streaming in usage in real-time.\n\n\n## Event shape\n\nEvents are the starting point for all usage calculations in the system, and are simple at their core:\n\n```ts\n{\n // customer_id and external_customer_id are used to\n // attribute usage to a given Customer. Exactly one of these\n // should be specified in a given ingestion event.\n\n // `customer_id` is the Orb generated identifier for the Customer,\n // which is returned from the Create customer API call.\n customer_id: string,\n\n // external_customer_id is an alternate identifier which is associated\n // with a Customer at creation time. This is treated as an alias for\n // customer_id, and is usually set to an identifier native to your system.\n external_customer_id: string,\n\n // A string name identifying the event, usually a usage\n // action. By convention, this should not contain any whitespace.\n event_name: string,\n\n // An ISO 8601 format date with no timezone offset.\n // This should represent the time that usage occurred\n // and is important to attribute usage to a given\n // billing period. See the notes below on determining the timestamp.\n // e.g. 2020-12-09T16:09:53Z\n timestamp: string,\n\n // A unique value, generated by the client, that is\n // used to de-duplicate events.\n // Exactly one event with a given\n // idempotency key will be ingested, which allows for\n // safe request retries.\n idempotency_key: string\n\n // Optional custom metadata to attach to the event.\n // This might include a numeric value used for aggregation,\n // or a string/boolean value used for filtering.\n // The schema of this dictionary need not be pre-declared, and\n // properties can be added at any time.\n properties: {\n [key: string]?: string | number | boolean,\n },\n}\n```\n\n## Required fields\nBecause events streamed to Orb are meant to be as flexible as possible, there are only a few required fields in every\nevent.\n\n- We recommend that `idempotency_key` are unique strings that you generated with V4 UUIDs, but only require that they\nuniquely identify an event (i.e. don\u2019t collide).\n- The `timestamp` field in the event body will be used to determine which billable period a given event falls into. For\nexample, with a monthly billing cycle starting from the first of December, Orb will calculate metrics based on events\nthat fall into the range `12-01 00:00:00 <= timestamp < 01-01 00:00:00`.\n\n## Logging metadata\n\nOrb allows tagging events with metadata using a flexible properties dictionary. Since Orb does not enforce a rigid\nschema for this field-set, key-value pairs can be added dynamically as your events evolve.\n\nThis dictionary can be helpful for a wide variety of use cases:\n\n- Numeric properties on events like `compute_time_ms` can later be inputs to our flexible query engine to determine\nusage.\n- Logging a region or cluster with each event can help you provide customers more granular visibility into their usage.\n- If you are using matrix pricing and matching a matrix price key with a property,\nyou should ensure the value for that property is sent as a string.\n\nWe encourage logging this metadata with an eye towards future use cases to ensure full coverage for historical data. The\ndatatype of the value in the properties dictionary is important for metric creation from an event source. Values that\nyou wish to numerically aggregate should be of numeric type in the event.\n\n\n## Determining event timestamp\nFor cases where usage is being reported in real time as it is occurring, timestamp should correspond to the time that\nusage occurred.\n\nIn cases where usage is reported in aggregate for a historical timeframe at a regular interval, we recommend setting the\nevent `timestamp` to the midpoint of the interval. As an example, if you have an hourly reporter that sends data once an\nhour for the previous hour of usage, setting the `timestamp` to the half-hour mark will ensure that the usage is counted\nwithin the correct period.\n\nNote that other time-related fields (e.g. time elapsed) can be added to the properties dictionary as necessary.\n\nIn cases where usage is reported in aggregate for a historical timeframe, the timestamp must be within the grace period\nset for your account. Events with `timestamp < current_time - grace_period` will not be accepted as a valid event, and\nwill throw validation errors. Enforcing the grace period enables Orb to accurately map usage to the correct billing\ncycle and ensure that all usage is billed for in the corresponding billing period.\n\nIn general, Orb does not expect events with future dated timestamps. In cases where the timestamp is 5 minutes ahead\nof the current time, the event will not be accepted as a valid event, and will throw validation errors.\n\n## Event validation\n\nOrb\u2019s validation ensures that you recognize errors in your events as quickly as possible, and the API provides\ninformative error messages to help you fix problems quickly.\n\nWe validate the following:\n\n- Exactly one of `customer_id` and `external_customer_id` should be specified.\n- If the `customer_id` is specified, the customer in Orb must exist.\n- If the `external_customer_id` is specified, the customer in Orb does not need to exist. Events will be attributed to any\nfuture customers with the `external_customer_id` on subscription creation.\n- `timestamp` must conform to ISO 8601 and represent a timestamp at most 5 minutes in the future. This timestamp should be\nsent in UTC timezone (no timezone offset).\n\n## Idempotency and retry semantics\n\nOrb's idempotency guarantees allow you to implement safe retry logic in the event of network or machine failures,\nensuring data fidelity. Each event in the request payload is associated with an idempotency key, and Orb guarantees that\na single idempotency key will be successfully ingested at most once. Note that when Orb encounters events with duplicate\nidempotency keys and differing event bodies in a batch of events, the entire batch will be rejected.\n\n- Successful responses return a 200 HTTP status code. The response contains information about previously processed\nevents.\n- Requests that return a `4xx` HTTP status code indicate a payload error and contain at least one event with a\nvalidation failure. An event with a validation failure can be re-sent to the ingestion endpoint (after the payload is\nfixed) with the original idempotency key since that key is not marked as processed.\n- Requests that return a `5xx` HTTP status code indicate a server-side failure. These requests should be retried in\ntheir entirety.\n\n\n## API usage and limits\nThe ingestion API is designed made for real-time streaming ingestion and architected for high throughput. Even if events\nare later deemed unnecessary or filtered out, we encourage you to log them to Orb if they may be relevant to billing\ncalculations in the future.\n\nTo take advantage of the real-time features of the Orb platform and avoid any chance of dropped events by producers, we\nrecommend reporting events to Orb frequently. Optionally, events can also be briefly aggregated at the source, as this\nAPI accepts an array of event bodies.\n\nOrb does not currently enforce a hard rate-limit for API usage or a maximum request payload size, but please give us a\nheads up if you\u2019re changing either of these factors by an order of magnitude from initial setup.\n\n\n#### Example: ingestion response\n\n```json\n{\n \"validation_failed\": []\n}\n```",
"operationId": "ingest",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "boolean",
"title": "Debug",
"description": "Pending Deprecation: Flag to enable additional debug information in the endpoint response",
"default": false,
"deprecated": true
},
"name": "debug",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Backfill Id",
"description": "If this ingestion request is part of a backfill, this parameter ties the ingested events to the backfill"
},
"name": "backfill_id",
"in": "query"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestRequestBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IngestionResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoice_line_items": {
"post": {
"tags": [
"Invoice"
],
"summary": "Create invoice line item",
"description": "This creates a one-off fixed fee invoice line item on an Invoice.\nThis can only be done for invoices that are in a `draft` status.\n\nThe behavior depends on which parameters are provided:\n- If `item_id` is provided without `name`: The item is looked up by ID, and the item's name\n is used for the line item.\n- If `name` is provided without `item_id`: An item with the given name is searched for in the account.\n If found, that item is used. If not found, a new item is created with that name.\n The new item's name is used for the line item.\n- If both `item_id` and `name` are provided: The item is looked up by ID for association,\n but the provided `name` is used for the line item (not the item's name).",
"operationId": "create-invoice-line-item",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateInvoiceLineItemParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceLineItem"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices": {
"get": {
"tags": [
"Invoice"
],
"summary": "List invoices",
"description": "This endpoint returns a list of all [`Invoice`](/core-concepts#invoice)s for an account in a list format.\n\nThe list of invoices is ordered starting from the most recently issued invoice date. The response also includes\n[`pagination_metadata`](/api-reference/pagination), which lets the caller retrieve the next page of results if they\nexist.\n\nBy default, this only returns invoices that are `issued`, `paid`, or `synced`.\n\nWhen fetching any `draft` invoices, this returns the last-computed invoice values for each draft invoice, which may\nnot always be up-to-date since Orb regularly refreshes invoices asynchronously.\n\nIf you don't need line item details, minimums, maximums, or discounts, prefer the\n[list invoices summary](/api-reference/invoice/list-invoices-summary) endpoint for better performance.",
"operationId": "list-invoices",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"name": "customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"name": "external_customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id"
},
"name": "subscription_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"name": "status",
"in": "query"
},
{
"required": false,
"style": "form",
"explode": true,
"schema": {
"oneOf": [
{
"items": {
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status[]"
},
"name": "status[]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date Window",
"description": "Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months."
},
"name": "due_date_window",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"due_date",
"invoice_date"
]
},
{
"type": "null"
}
],
"title": "Date Type",
"default": "invoice_date"
},
"name": "date_type",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"name": "due_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Gt]"
},
"name": "due_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Lt]"
},
"name": "due_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount"
},
"name": "amount",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Gt]"
},
"name": "amount[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Lt]"
},
"name": "amount[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Recurring"
},
"name": "is_recurring",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gte]"
},
"name": "invoice_date[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gt]"
},
"name": "invoice_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lt]"
},
"name": "invoice_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lte]"
},
"name": "invoice_date[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoices"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Invoice"
],
"summary": "Create a one-off invoice",
"description": "This endpoint is used to create a one-off invoice for a customer.",
"operationId": "create-invoice",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateOneOffInvoiceParams"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/summary": {
"get": {
"tags": [
"Invoice"
],
"summary": "List invoices summary",
"description": "This is a lighter-weight endpoint that returns a list of all [`Invoice`](/core-concepts#invoice) summaries for an account in a\nlist format.\n\nThese invoice summaries do not include line item details, minimums, maximums, and discounts, making this endpoint more\nefficient.\n\nThe list of invoices is ordered starting from the most recently issued invoice date. The response also includes\n[`pagination_metadata`](/api-reference/pagination), which lets the caller retrieve the next page of results if they\nexist.\n\nBy default, this only returns invoices that are `issued`, `paid`, or `synced`.\n\nWhen fetching any `draft` invoices, this returns the last-computed invoice values for each draft invoice, which may\nnot always be up-to-date since Orb regularly refreshes invoices asynchronously.",
"operationId": "list-invoices-summary",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"name": "customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"name": "external_customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id"
},
"name": "subscription_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"name": "status",
"in": "query"
},
{
"required": false,
"style": "form",
"explode": true,
"schema": {
"oneOf": [
{
"items": {
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status[]"
},
"name": "status[]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date Window",
"description": "Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months."
},
"name": "due_date_window",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"due_date",
"invoice_date"
]
},
{
"type": "null"
}
],
"title": "Date Type",
"default": "invoice_date"
},
"name": "date_type",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"name": "due_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Gt]"
},
"name": "due_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Lt]"
},
"name": "due_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount"
},
"name": "amount",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Gt]"
},
"name": "amount[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Lt]"
},
"name": "amount[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Recurring"
},
"name": "is_recurring",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gte]"
},
"name": "invoice_date[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gt]"
},
"name": "invoice_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lt]"
},
"name": "invoice_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lte]"
},
"name": "invoice_date[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSummarys"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/summary/{invoice_id}/issue": {
"post": {
"tags": [
"Invoice"
],
"summary": "Issue invoice summary",
"description": "This endpoint allows an eligible invoice to be issued manually. This is only possible with invoices where status is `draft`,\n`will_auto_issue` is false, and an `eligible_to_issue_at` is a time in the past. Issuing an invoice could possibly trigger\nside effects, some of which could be customer-visible (e.g. sending emails, auto-collecting payment,\nsyncing the invoice to external providers, etc).\n\nThis is a lighter-weight alternative to the issue invoice endpoint, returning an invoice summary without any line item details.",
"operationId": "issue-invoice-summary",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IssueInvoiceRequestParams"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/InvoiceSummary"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/upcoming": {
"get": {
"tags": [
"Invoice"
],
"summary": "Fetch upcoming invoice",
"description": "This endpoint can be used to fetch the upcoming [invoice](/core-concepts#invoice) for the current billing\nperiod given a subscription.",
"operationId": "fetch-upcoming-invoice",
"parameters": [
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "Subscription Id"
},
"name": "subscription_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpcomingInvoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}": {
"get": {
"tags": [
"Invoice"
],
"summary": "Fetch invoice",
"description": "This endpoint is used to fetch an [`Invoice`](/core-concepts#invoice) given an identifier.",
"operationId": "fetch-invoice",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Invoice"
],
"summary": "Update invoice",
"description": "This endpoint allows you to update the `metadata`, `net_terms`, `due_date`, `invoice_date`, and `auto_collection`\nproperties on an invoice. If you pass null for the metadata value, it will clear any existing metadata for that invoice.\n\n`metadata` can be modified regardless of invoice state.\n`net_terms`, `due_date`, `invoice_date`, and `auto_collection` can only be modified if the invoice is in a `draft` state.\n`invoice_date` can only be modified for non-subscription invoices.",
"operationId": "update-invoice",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateInvoiceRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/invoice_line_items/{line_item_id}": {
"delete": {
"tags": [
"Invoice"
],
"summary": "Delete invoice line item",
"description": "This endpoint deletes an invoice line item from a draft invoice.\n\nThis endpoint only allows deletion of one-off line items (not subscription-based line items).\nThe invoice must be in a draft status for this operation to succeed.",
"operationId": "delete-invoice-line-item",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "line_item_id",
"in": "path"
}
],
"responses": {
"204": {
"description": "No Content",
"headers": {}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/issue": {
"post": {
"tags": [
"Invoice"
],
"summary": "Issue invoice",
"description": "This endpoint allows an eligible invoice to be issued manually. This is only possible with invoices where status is `draft`,\n`will_auto_issue` is false, and an `eligible_to_issue_at` is a time in the past. Issuing an invoice could possibly trigger\nside effects, some of which could be customer-visible (e.g. sending emails, auto-collecting payment,\nsyncing the invoice to external providers, etc).",
"operationId": "issue-invoice",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IssueInvoiceRequestParams"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/mark_paid": {
"post": {
"tags": [
"Invoice"
],
"summary": "Mark invoice as paid",
"description": "This endpoint allows an invoice's status to be set to the `paid` status. This can only be done to invoices that are in\nthe `issued` or `synced` status.",
"operationId": "mark-invoice-as-paid",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MarkAsPaidRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/pay": {
"post": {
"tags": [
"Invoice"
],
"summary": "Pay invoice",
"description": "This endpoint collects payment for an invoice. By default, it uses the customer's default payment method.\nOptionally, a shared payment token (SPT) can be provided to pay using agent-granted credentials instead.\nThis action can only be taken on invoices with status \"issued\".",
"operationId": "pay-invoice",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PayInvoiceParams"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/regenerate_invoice_pdf": {
"post": {
"tags": [
"Invoice"
],
"summary": "Regenerate invoice PDF",
"description": "This endpoint triggers a regeneration of the PDF for a finalized invoice.\n\nThe invoice must be finalized (`issued`, `paid`, `synced`, or `void`) and must already have an\nexisting PDF. The original PDF is archived (not permanently deleted) to maintain an audit trail.\n\n**Important Legal Considerations:**\n\nRegenerating invoice PDFs may not be permitted in all jurisdictions. Many tax authorities require\nthat issued invoices remain unmodified. Before using this endpoint, ensure that:\n\n- Your local tax regulations permit modification of issued billing documents\n- You have a legitimate business reason (e.g., fixing template errors, updating branding)\n- You maintain proper records of the original PDF (archived automatically by Orb)\n\nRecommended use cases:\n- Correcting template rendering issues\n- Applying updated company branding\n- Updating customer data that was incorrect at issuance",
"operationId": "regenerate-invoice-pdf",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/regenerate_receipt_pdf": {
"post": {
"tags": [
"Invoice"
],
"summary": "Regenerate receipt PDF",
"description": "This endpoint triggers a regeneration of the receipt PDF for a paid invoice.\n\nThe invoice must be in `paid` status and must already have an existing receipt PDF.\nThe original PDF is archived (not permanently deleted) to maintain an audit trail.\n\n**Important Legal Considerations:**\n\nRegenerating receipt PDFs may not be permitted in all jurisdictions. Many tax authorities require\nthat issued receipts remain unmodified. Before using this endpoint, ensure that:\n\n- Your local tax regulations permit modification of issued billing documents\n- You have a legitimate business reason (e.g., fixing template errors, updating branding)\n- You maintain proper records of the original PDF (archived automatically by Orb)\n\nRecommended use cases:\n- Correcting template rendering issues\n- Applying updated company branding\n- Updating customer data that was incorrect at issuance",
"operationId": "regenerate-receipt-pdf",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/invoices/{invoice_id}/void": {
"post": {
"tags": [
"Invoice"
],
"summary": "Void invoice",
"description": "This endpoint allows an invoice's status to be set to the `void` status. This can only be done to invoices that are in\nthe `issued` status.\n\nIf the associated invoice has used the customer balance to change the amount due, the customer balance operation\nwill be reverted. For example, if the invoice used \\$10 of customer balance, that amount will be added back to the\ncustomer balance upon voiding.\n\nIf the invoice was used to purchase a credit block, but the invoice is not yet paid, the credit block will be voided. If the\ninvoice was created due to a top-up, the top-up will be disabled.",
"operationId": "void-invoice",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "invoice_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invoice"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/items": {
"get": {
"tags": [
"Item"
],
"summary": "List items",
"description": "This endpoint returns a list of all Items, ordered in descending order by creation time.",
"operationId": "list-items",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Items"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Item"
],
"summary": "Create item",
"description": "This endpoint is used to create an [Item](/core-concepts#item).",
"operationId": "create-item",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewItem"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/items/{item_id}": {
"get": {
"tags": [
"Item"
],
"summary": "Fetch item",
"description": "This endpoint returns an item identified by its item_id.",
"operationId": "fetch-item",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "item_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Item"
],
"summary": "Update item",
"description": "This endpoint can be used to update properties on the Item.",
"operationId": "update-item",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "item_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MapItemRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/items/{item_id}/archive": {
"post": {
"tags": [
"Item"
],
"summary": "Archive item",
"operationId": "archive-item",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "item_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Item"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/license_types": {
"get": {
"tags": [
"LicenseType"
],
"summary": "List license types",
"description": "This endpoint returns a list of all license types configured for the account, ordered in ascending order by creation time.\n\nLicense types are used to group licenses and define billing behavior. Each license type has a name and a\ngrouping key that determines how metrics are aggregated for billing purposes.",
"operationId": "list-license-types",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseTypes"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"LicenseType"
],
"summary": "Create license type",
"description": "This endpoint is used to create a new license type.\n\nLicense types are used to group licenses and define billing behavior. Each license type has a name and a\ngrouping key that determines how metrics are aggregated for billing purposes.",
"operationId": "create-license-type",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewLicenseType"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseType"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/license_types/{license_type_id}": {
"get": {
"tags": [
"LicenseType"
],
"summary": "Fetch license type",
"description": "This endpoint returns a license type identified by its license_type_id.\n\nUse this endpoint to retrieve details about a specific license type, including its name and grouping key.",
"operationId": "fetch-license-type",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "license_type_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseType"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses": {
"get": {
"tags": [
"License"
],
"summary": "List licenses",
"description": "This endpoint returns a list of all licenses for a subscription.",
"operationId": "list-licenses",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "Subscription Id"
},
"name": "subscription_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id"
},
"name": "license_type_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External License Id"
},
"name": "external_license_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"active",
"inactive"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseApiResources"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"License"
],
"summary": "Create a new license for a user",
"description": "This endpoint is used to create a new license for a user.\n\nIf a start date is provided, the license will be activated at the **start** of the specified date in the customer's timezone.\nOtherwise, the activation time will default to the **start** of the current day in the customer's timezone.",
"operationId": "create-license",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewLicense"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseApiResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/external_license_id/{external_license_id}": {
"get": {
"tags": [
"License"
],
"summary": "Fetch license by external license id",
"description": "This endpoint is used to fetch a license given an external license identifier.",
"operationId": "fetch-license-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_license_id",
"in": "path"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "Subscription Id",
"description": "The ID of the subscription to fetch the license for."
},
"name": "subscription_id",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "License Type Id",
"description": "The ID of the license type to fetch the license for."
},
"name": "license_type_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseApiResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/external_licenses/{external_license_id}/usage": {
"get": {
"tags": [
"License"
],
"summary": "Get usage for a license by external license ID",
"description": "Returns usage and remaining credits for a license identified by its external license ID.\n\nDate range defaults to the current billing period if not specified.",
"operationId": "get-license-usage-by-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_license_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"name": "start_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"name": "end_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"name": "group_by",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "Subscription Id",
"description": "The subscription ID to get license usage for."
},
"name": "subscription_id",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "License Type Id",
"description": "The license type ID to filter licenses by."
},
"name": "license_type_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUsages"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/usage": {
"get": {
"tags": [
"License"
],
"summary": "Get usage for all licenses of a type on a subscription",
"description": "Returns usage and remaining credits for all licenses of a given type on a subscription.\n\nDate range defaults to the current billing period if not specified.",
"operationId": "get-license-usage-by-type",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"name": "start_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"name": "end_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"name": "group_by",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "Subscription Id",
"description": "The subscription ID to get license usage for."
},
"name": "subscription_id",
"in": "query"
},
{
"required": true,
"style": "form",
"schema": {
"type": "string",
"title": "License Type Id",
"description": "The license type ID to filter licenses by."
},
"name": "license_type_id",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUsages"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/{license_id}": {
"get": {
"tags": [
"License"
],
"summary": "Fetch license",
"description": "This endpoint is used to fetch a license given an identifier.",
"operationId": "fetch-license",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "license_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseApiResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/{license_id}/deactivate": {
"post": {
"tags": [
"License"
],
"summary": "Deactivate license",
"description": "This endpoint is used to deactivate an existing license.\n\nIf an end date is provided, the license will be deactivated at the **start** of the specified date in the customer's timezone.\nOtherwise, the deactivation time will default to the **end** of the current day in the customer's timezone.",
"operationId": "deactivate-license",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "license_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeactivateLicense"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseApiResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/licenses/{license_id}/usage": {
"get": {
"tags": [
"License"
],
"summary": "Get usage for a specific license",
"description": "Returns usage and remaining credits for a specific license over a date range.\n\nDate range defaults to the current billing period if not specified.",
"operationId": "get-license-usage-by-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "license_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"name": "start_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"name": "end_date",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"name": "group_by",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
},
"name": "limit",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LicenseUsages"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/metrics": {
"get": {
"tags": [
"Metric"
],
"summary": "List metrics",
"description": "This endpoint is used to list [metrics](/core-concepts#metric).\nIt returns information about the metrics including its name, description, and item.",
"operationId": "list-metrics",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableMetrics"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Metric"
],
"summary": "Create metric",
"description": "This endpoint is used to create a [metric](/core-concepts###metric) using a SQL string.\nSee [SQL support](/extensibility/advanced-metrics#sql-support)\nfor a description of constructing SQL queries with examples.",
"operationId": "create-metric",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewBillableMetric"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableMetric"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/metrics/{metric_id}": {
"get": {
"tags": [
"Metric"
],
"summary": "Get metric",
"description": "This endpoint is used to fetch [metric](/core-concepts#metric) details given a metric identifier.\nIt returns information about the metrics including its name, description, and item.",
"operationId": "fetch-metric",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "metric_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableMetric"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Metric"
],
"summary": "Update metric",
"description": "This endpoint allows you to update the `metadata` property on a metric. If you pass `null` for the metadata value,\nit will clear any existing metadata for that invoice.",
"operationId": "update-metric",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "metric_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateMetricRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableMetric"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/ping": {
"get": {
"tags": [
"Availability"
],
"summary": "Check availability",
"description": "This endpoint allows you to test your connection to the Orb API and check the validity of your API key, passed in\nthe Authorization header. This is particularly useful for checking that your environment is set up properly, and is\na great choice for connectors and integrations.\n\nThis API does not have any side-effects or return any Orb resources.",
"operationId": "ping",
"parameters": [],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PingResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans": {
"get": {
"tags": [
"Plan"
],
"summary": "List plans",
"description": "This endpoint returns a list of all [plans](/core-concepts#plan-and-price) for an account in a list format.\nThe list of plans is ordered starting from the most recently created plan.\nThe response also includes [`pagination_metadata`](/api-reference/pagination),\nwhich lets the caller retrieve the next page of results if they exist.",
"operationId": "list-plans",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"type": "string",
"enum": [
"active",
"archived",
"draft"
],
"title": "Status",
"description": "The plan status to filter to ('active', 'archived', or 'draft')."
},
"name": "status",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plans"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Plan"
],
"summary": "Create plan",
"description": "This endpoint allows creation of plans including their prices.",
"operationId": "create-plan",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPlan"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/external_plan_id/{external_plan_id}": {
"get": {
"tags": [
"Plan"
],
"summary": "Fetch plan by external ID",
"description": "This endpoint is used to fetch [plan](/core-concepts##plan-and-price) details given an external_plan_id\nidentifier. It returns information about the prices included in the plan and their configuration, as well as\nthe product that the plan is attached to.\n\nIf multiple plans are found to contain the specified external_plan_id, the active plans will take priority over\narchived ones, and among those, the endpoint will return the most recently created plan.\n\n## Serialized prices\nOrb supports a few different pricing models\nout of the box. Each of these models is serialized differently in a given [Price](/core-concepts#plan-and-price)\nobject. The `model_type` field determines the key for the configuration object that is present. A detailed explanation\nof price types can be found in the [Price schema](/core-concepts#plan-and-price). \"",
"operationId": "fetch-plan-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_plan_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Plan"
],
"summary": "Update plan by external ID",
"description": "This endpoint can be used to update the `external_plan_id`, `description`, and `metadata` of an existing plan.\n\nOther fields on a plan are currently immutable.",
"operationId": "update-plan-external",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditPlan"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/external_plan_id/{external_plan_id}/set_default_version": {
"post": {
"tags": [
"Plan"
],
"summary": "Set plan version as default by external ID",
"description": "This endpoint allows setting the default version of a plan.",
"operationId": "set-default-version-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultVersion"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/external_plan_id/{external_plan_id}/versions": {
"post": {
"tags": [
"Plan"
],
"summary": "Create plan version by external ID",
"description": "This endpoint allows the creation of a new plan version for an existing plan.",
"operationId": "create-plan-version-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPlanVersion"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersion"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/external_plan_id/{external_plan_id}/versions/{version}": {
"get": {
"tags": [
"Plan"
],
"summary": "Fetch plan version by external ID",
"description": "This endpoint is used to fetch a plan version. It returns the phases, prices, and adjustments present on this\nversion of the plan.",
"operationId": "fetch-plan-version-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "version",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "external_plan_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersion"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}": {
"get": {
"tags": [
"Plan"
],
"summary": "Fetch plan",
"description": "This endpoint is used to fetch [plan](/core-concepts#plan-and-price) details given a plan identifier.\nIt returns information about the prices included in the plan and their configuration, as well as the product\nthat the plan is attached to.\n\n## Serialized prices\nOrb supports a few different pricing models out of the box.\nEach of these models is serialized differently in a given [Price](/core-concepts#plan-and-price) object.\nThe `model_type` field determines the key for the configuration object that is present. A detailed explanation of\nprice types can be found in the [Price schema](/core-concepts#plan-and-price).\n\n## Phases\nOrb supports plan phases, also known as contract ramps. For plans with phases, the serialized prices refer to\nall prices across all phases.",
"operationId": "fetch-plan",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "plan_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Plan"
],
"summary": "Update plan by id",
"description": "This endpoint can be used to update the `external_plan_id`, `description`, and `metadata` of an existing plan.\n\nOther fields on a plan are currently immutable.",
"operationId": "update-plan",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EditPlan"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/migrations": {
"get": {
"tags": [
"Plan"
],
"summary": "List migrations",
"description": "This endpoint returns a list of all migrations for a plan.\nThe list of migrations is ordered starting from the most recently created migration.\nThe response also includes pagination_metadata, which lets the caller retrieve the next page of results if they exist.",
"operationId": "list-migrations",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "plan_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersionChanges"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/migrations/{migration_id}": {
"get": {
"tags": [
"Plan"
],
"summary": "Fetch migration",
"operationId": "fetch-migration",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "plan_id",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "migration_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersionChange"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/migrations/{migration_id}/cancel": {
"post": {
"tags": [
"Plan"
],
"summary": "Cancel migration",
"description": "This endpoint cancels a migration.",
"operationId": "cancel-migration",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "plan_id",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "migration_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersionChange"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/set_default_version": {
"post": {
"tags": [
"Plan"
],
"summary": "Set plan version as default",
"description": "This endpoint allows setting the default version of a plan.",
"operationId": "set-default-version",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SetDefaultVersion"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Plan"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/versions": {
"post": {
"tags": [
"Plan"
],
"summary": "Create plan version",
"description": "This endpoint allows the creation of a new plan version for an existing plan.",
"operationId": "create-plan-version",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "plan_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewPlanVersion"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersion"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/plans/{plan_id}/versions/{version}": {
"get": {
"tags": [
"Plan"
],
"summary": "Fetch plan version",
"description": "This endpoint is used to fetch a plan version. It returns the phases, prices, and adjustments present on this\nversion of the plan.",
"operationId": "fetch-plan-version",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "version",
"in": "path"
},
{
"required": true,
"style": "simple",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"name": "plan_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PlanVersion"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices": {
"get": {
"tags": [
"Price"
],
"summary": "List prices",
"description": "This endpoint is used to list all add-on prices created using the [price creation endpoint](/api-reference/price/create-price).",
"operationId": "list-prices",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Prices"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Price"
],
"summary": "Create price",
"description": "This endpoint is used to create a [price](/product-catalog/price-configuration).\nA price created using this endpoint is always an add-on, meaning that it's not associated with a specific plan and can instead\nbe individually added to subscriptions, including subscriptions on different plans.\n\nAn `external_price_id` can be optionally specified as an alias to allow ergonomic interaction with prices in the Orb API.\n\nSee the [Price resource](/product-catalog/price-configuration) for the specification of\ndifferent price model configurations possible in this endpoint.",
"operationId": "create-price",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewFloatingPrice"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Price"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices/evaluate": {
"post": {
"tags": [
"Price"
],
"summary": "Evaluate multiple prices",
"description": "This endpoint is used to evaluate the output of price(s) for a given customer and time range over ingested events.\nIt enables filtering and grouping the output using\n[computed properties](/extensibility/advanced-metrics#computed-properties),\nsupporting the following workflows:\n\n1. Showing detailed usage and costs to the end customer.\n2. Auditing subtotals on invoice line items.\n\nFor these workflows, the expressiveness of computed properties in both the filters and grouping is critical.\nFor example, if you'd like to show your customer their usage grouped by hour and another property, you can\ndo so with the following `grouping_keys`:\n`[\"hour_floor_timestamp_millis(timestamp_millis)\", \"my_property\"]`.\nIf you'd like to examine a customer's usage for a specific property value, you can do so with the following `filter`:\n`my_property = 'foo' AND my_other_property = 'bar'`.\n\nPrices may either reference existing prices in your Orb account or be defined inline in the request body. Up to\n100 prices can be evaluated in a single request.\n\nPrices are evaluated on ingested events and the start of the time range must be no more than 100 days ago. To evaluate\nbased off a set of provided events, the [evaluate preview events](/api-reference/price/evaluate-preview-events) endpoint\ncan be used instead.\n\nNote that this is a POST endpoint rather than a GET endpoint because it employs a JSON body rather than query parameters.",
"operationId": "evaluate-multiple-prices",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateMultiplePricesBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateMultiplePriceResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices/evaluate_preview_events": {
"post": {
"tags": [
"Price",
"Event"
],
"summary": "Evaluate preview events",
"description": "This endpoint evaluates prices on preview events instead of actual usage, making it ideal for building\nprice calculators and cost estimation tools. You can filter and group results using\n[computed properties](/extensibility/advanced-metrics#computed-properties) to analyze\npricing across different dimensions.\n\nPrices may either reference existing prices in your Orb account or be defined inline in the request body. The endpoint has the\nfollowing limitations:\n1. Up to 100 prices can be evaluated in a single request.\n2. Up to 500 preview events can be provided in a single request.\n\nA top-level customer_id is required to evaluate the preview events. Additionally, all events without a customer_id will have\nthe top-level customer_id added.\n\nNote that this is a POST endpoint rather than a GET endpoint because it employs a JSON body rather than query parameters.",
"operationId": "evaluate-preview-events",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateMultiplePricesWithPreviewEventsBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluateMultiplePriceResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices/external_price_id/{external_price_id}": {
"get": {
"tags": [
"Price"
],
"summary": "Fetch price by external price id",
"description": "This endpoint returns a price given an external price id.\nSee the [price creation API](/api-reference/price/create-price) for more information about external price aliases.",
"operationId": "fetch-price-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_price_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Price"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Price"
],
"summary": "Update price by external price id",
"description": "This endpoint allows you to update the `metadata` property on a price. If you pass null for the metadata value,\nit will clear any existing metadata for that price.",
"operationId": "update-price-by-external-id",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "external_price_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePriceRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Price"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices/{price_id}": {
"get": {
"tags": [
"Price"
],
"summary": "Fetch price",
"description": "This endpoint returns a price given an identifier.",
"operationId": "fetch-price",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "price_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Price"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Price"
],
"summary": "Update price",
"description": "This endpoint allows you to update the `metadata` property on a price. If you pass null for the metadata value,\nit will clear any existing metadata for that price.",
"operationId": "update-price",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "price_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdatePriceRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Price"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/prices/{price_id}/evaluate": {
"post": {
"tags": [
"Price"
],
"summary": "Evaluate price",
"description": "[NOTE] It is recommended to use the `/v1/prices/evaluate` which offers further functionality, such as multiple prices, inline\nprice definitions, and querying over preview events.\n\nThis endpoint is used to evaluate the output of a price for a given customer and time range.\nIt enables filtering and grouping the output using\n[computed properties](/extensibility/advanced-metrics#computed-properties),\nsupporting the following workflows:\n\n1. Showing detailed usage and costs to the end customer.\n2. Auditing subtotals on invoice line items.\n\nFor these workflows, the expressiveness of computed properties in both the filters and grouping is critical.\nFor example, if you'd like to show your customer their usage grouped by hour and another property, you can\ndo so with the following `grouping_keys`:\n`[\"hour_floor_timestamp_millis(timestamp_millis)\", \"my_property\"]`.\nIf you'd like to examine a customer's usage for a specific property value, you can do so with the following `filter`:\n`my_property = 'foo' AND my_other_property = 'bar'`.\n\nBy default, the start of the time range must be no more than 100 days ago and the length of the results\nmust be no greater than 1000. Note that this is a POST endpoint rather than a GET endpoint because it\nemploys a JSON body rather than query parameters.",
"operationId": "evaluate-price",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "price_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatePriceBody"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EvaluatePriceResource"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscription_changes": {
"get": {
"tags": [
"Subscription Change"
],
"summary": "List subscription changes",
"description": "This endpoint returns a list of pending subscription changes for a customer. Use the\n[Fetch Subscription Change](fetch-subscription-change) endpoint to retrieve the expected subscription state\nafter the pending change is applied.",
"operationId": "list-subscription-changes",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"name": "customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"name": "external_customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"pending",
"applied",
"cancelled"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"name": "status",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionChangeListResponses"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscription_changes/{subscription_change_id}": {
"get": {
"tags": [
"Subscription Change"
],
"summary": "Fetch subscription change",
"description": "This endpoint returns a subscription change given an identifier.\n\nA subscription change is created by including `Create-Pending-Subscription-Change: True` in the header of\na subscription mutation API call (e.g. [create subscription endpoint](/api-reference/subscription/create-subscription),\n[schedule plan change endpoint](/api-reference/subscription/schedule-plan-change), ...). The subscription change\nwill be referenced by the `pending_subscription_change` field in the response.",
"operationId": "fetch-subscription-change",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_change_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionChangeResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscription_changes/{subscription_change_id}/apply": {
"post": {
"tags": [
"Subscription Change"
],
"summary": "Apply subscription change",
"description": "Apply a subscription change to perform the intended action. If a positive amount is passed with a request to\nthis endpoint, any eligible invoices that were created will be issued immediately if they only contain in-advance fees.",
"operationId": "apply-subscription-change",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_change_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApplyParams"
}
}
},
"required": false
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionChangeResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscription_changes/{subscription_change_id}/cancel": {
"post": {
"tags": [
"Subscription Change"
],
"summary": "Cancel subscription change",
"description": "Cancel a subscription change. The change can no longer be applied. A subscription can only have one \"pending\" change at a\ntime - use this endpoint to cancel an existing change before creating a new one.",
"operationId": "cancel-subscription-change",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_change_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionChangeResponse"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions": {
"get": {
"tags": [
"Subscription"
],
"summary": "List subscriptions",
"description": "This endpoint returns a list of all subscriptions for an account as a [paginated](/api-reference/pagination) list,\nordered starting from the most recently created subscription. For a full discussion of the subscription resource,\nsee [Subscription](/core-concepts##subscription).\n\nSubscriptions can be filtered for a specific customer by using either the customer_id or external_customer_id query parameters.\nTo filter subscriptions for multiple customers, use the customer_id[] or external_customer_id[] query parameters.\n\nSubscriptions can be filtered by status using the status query parameter (one of `active`, `ended`, or `upcoming`).\nTo filter for multiple statuses in a single request, use the status[] query parameter, e.g.\n`status[]=active&status[]=ended`.",
"operationId": "list-subscriptions",
"parameters": [
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"name": "customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"explode": true,
"schema": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Customer Id[]"
},
"name": "customer_id[]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"name": "external_customer_id",
"in": "query"
},
{
"required": false,
"style": "form",
"explode": true,
"schema": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "External Customer Id[]"
},
"name": "external_customer_id[]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Id"
},
"name": "plan_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id"
},
"name": "external_plan_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"name": "status",
"in": "query"
},
{
"required": false,
"style": "form",
"explode": true,
"schema": {
"oneOf": [
{
"items": {
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status[]"
},
"name": "status[]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"name": "created_at[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"name": "created_at[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"name": "created_at[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
},
"name": "created_at[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscriptions"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"post": {
"tags": [
"Subscription"
],
"summary": "Create subscription",
"description": "A subscription represents the purchase of a plan by a customer. The customer is identified by either the `customer_id`\nor the `external_customer_id`, and exactly one of these fields must be provided.\n\nBy default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at the\ncadence that's configured in the plan definition.\n\nThe default configuration for subscriptions in Orb is **In-advance billing** and **Beginning of month alignment** (see\n[Subscription](/core-concepts##subscription) for more details).\n\nIn order to change the alignment behavior, Orb also supports billing subscriptions on the day of the month they are\ncreated. If `align_billing_with_subscription_start_date = true` is specified, subscriptions have billing cycles that are\naligned with their `start_date`. For example, a subscription that begins on January 15th will have a billing cycle from\nJanuary 15th to February 15th. Every subsequent billing cycle will continue to start and invoice on the 15th.\n\nIf the \"day\" value is greater than the number of days in the month, the next billing cycle will start at the end of the\nmonth. For example, if the start_date is January 31st, the next billing cycle will start on February 28th.\n\nIf a customer was created with a currency, Orb only allows subscribing the customer to a plan with a matching\n`invoicing_currency`. If the customer does not have a currency set, on subscription creation, we set the customer's\ncurrency to be the `invoicing_currency` of the plan.\n\n## Customize your customer's subscriptions\n\nPrices and adjustments in a plan can be added, removed, or replaced for the subscription being created. This is useful when a\ncustomer has prices that differ from the default prices for a specific plan.\n\n\nThis feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your\nSubscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)\n\n\n### Adding Prices\n\nTo add prices, provide a list of objects with the key `add_prices`. An object in the list must specify an existing add-on price\nwith a `price_id` or `external_price_id` field, or create a new add-on price by including an object with the key `price`,\nidentical to what would be used in the request body for the [create price endpoint](/api-reference/price/create-price). See the\n[Price resource](/product-catalog/price-configuration) for the specification\nof different price model configurations possible in this object.\n\nIf the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the\nprice should be added to.\n\nAn object in the list can specify an optional `start_date` and optional `end_date`. This is equivalent to creating a price\ninterval with the [add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).\nIf unspecified, the start or end date of the phase or subscription will be used.\n\nAn object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments\nwhich apply only to this price.\n\nAdditionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference this price when\n[adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to refer to\nthe price in future API calls.\n\n### Removing Prices\n\nTo remove prices, provide a list of objects with the key `remove_prices`. An object in the list must specify a plan price with\neither a `price_id` or `external_price_id` field.\n\n### Replacing Prices\n\nTo replace prices, provide a list of objects with the key `replace_prices`. An object in the list must specify a plan price to\nreplace with the `replaces_price_id` key, and it must specify a price to replace it with by either referencing an existing\nadd-on price with a `price_id` or `external_price_id` field, or by creating a new add-on price by including an object with the\nkey `price`, identical to what would be used in the request body for\nthe [create price endpoint](/api-reference/price/create-price).\nSee the [Price resource](/product-catalog/price-configuration)\nfor the specification of different price model configurations possible in this\nobject.\n\nFor fixed fees, an object in the list can supply a `fixed_price_quantity` instead of a `price`, `price_id`, or\n`external_price_id` field. This will update only the quantity for the price, similar to the\n[Update price quantity](/api-reference/subscription/update-price-quantity) endpoint.\n\nThe replacement price will have the same phase, if applicable, and the same start and end dates as the price it replaces.\n\nAn object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments\nwhich apply only to this price.\n\nAdditionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference the replacement\nprice when [adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to\nrefer to the price in future API calls.\n\n### Adding adjustments\n\nTo add adjustments, provide a list of objects with the key `add_adjustments`. An object in the list must include an object with\nthe key `adjustment`, identical to the adjustment object in the\n[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).\n\nIf the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the\nadjustment should be added to.\n\nAn object in the list can specify an optional `start_date` and optional `end_date`. If unspecified, the start or end date of the\nphase or subscription will be used.\n\n### Removing adjustments\n\nTo remove adjustments, provide a list of objects with the key `remove_adjustments`. An object in the list must include a key,\n`adjustment_id`, with the ID of the adjustment to be removed.\n\n### Replacing adjustments\n\nTo replace adjustments, provide a list of objects with the key `replace_adjustments`. An object in the list must specify a plan\nadjustment to replace with the `replaces_adjustment_id` key, and it must specify an adjustment to replace it with by including\nan object with the key `adjustment`, identical to the adjustment object in the\n[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).\n\nThe replacement adjustment will have the same phase, if applicable, and the same start and end dates as the adjustment it\nreplaces.\n\n## Price overrides (DEPRECATED)\n\n\nPrice overrides are being phased out in favor adding/removing/replacing prices. (See\n[Customize your customer's subscriptions](/api-reference/subscription/create-subscription))\n\n\nPrice overrides are used to update some or all prices in a plan for the specific subscription being created. This is\nuseful when a new customer has negotiated a rate that is unique to the customer.\n\nTo override prices, provide a list of objects with the key `price_overrides`. The price object in the list of overrides\nis expected to contain the existing price id, the `model_type` and configuration.\n(See the [Price resource](/product-catalog/price-configuration)\nfor the specification of different price model configurations.) The numerical values can be updated, but the billable metric,\ncadence, type, and name of a price can not be overridden.\n\n### Maximums and Minimums\nMinimums and maximums, much like price overrides, can be useful when a new customer has negotiated a new or different\nminimum or maximum spend cap than the default for a given price. If one exists for a price\nand null is provided for the minimum/maximum override on creation, then there\nwill be no minimum/maximum on the new subscription. If no value is provided, then the default price maximum or minimum is\nused.\n\nTo add a minimum for a specific price, add `minimum_amount` to the specific price in the `price_overrides` object.\n\nTo add a maximum for a specific price, add `maximum_amount` to the specific price in the `price_overrides` object.\n\n### Minimum override example\n\nPrice minimum override example:\n\n```json\n{\n ...\n \"id\": \"price_id\",\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"0.50\"\n },\n \"minimum_amount\": \"100.00\"\n ...\n}\n```\n\n\nRemoving an existing minimum example\n```json\n{\n ...\n \"id\": \"price_id\",\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"0.50\"\n },\n \"minimum_amount\": null\n ...\n}\n```\n\n### Discounts\nDiscounts, like price overrides, can be useful when a new customer has negotiated a new or different discount than the default\nfor a price. If a discount exists for a price and a null discount is provided on creation, then there will be no discount on the\nnew subscription.\n\nTo add a discount for a specific price, add `discount` to the price in the `price_overrides` object. Discount should be a\ndictionary of the format:\n```ts\n{\n \"discount_type\": \"amount\" | \"percentage\" | \"usage\",\n \"amount_discount\": string,\n \"percentage_discount\": string,\n \"usage_discount\": string\n}\n```\nwhere either `amount_discount`, `percentage_discount`, or `usage_discount` is provided.\n\nPrice discount example\n```json\n{\n ...\n \"id\": \"price_id\",\n \"model_type\": \"unit\",\n \"unit_config\": {\n \"unit_amount\": \"0.50\"\n },\n \"discount\": {\"discount_type\": \"amount\", \"amount_discount\": \"175\"},\n}\n```\n\nRemoving an existing discount example\n```json\n{\n \"customer_id\": \"customer_id\",\n \"plan_id\": \"plan_id\",\n \"discount\": null,\n \"price_overrides\": [ ... ]\n ...\n}\n```\n\n## Threshold Billing\n\nOrb supports invoicing for a subscription when a preconfigured usage threshold is hit. To enable threshold billing, pass\nin an `invoicing_threshold`, which is specified in the subscription's invoicing currency, when creating a subscription.\nE.g. pass in `10.00` to issue an invoice when usage amounts hit \\$10.00 for a subscription that invoices in USD.\n\n## Limits\nBy default, Orb limits the number of subscriptions per customer to 100.",
"operationId": "create-subscription",
"parameters": [],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NewSubscription"
}
}
},
"required": true
},
"responses": {
"201": {
"description": "Created",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}": {
"get": {
"tags": [
"Subscription"
],
"summary": "Fetch subscription",
"description": "This endpoint is used to fetch a [Subscription](/core-concepts##subscription) given an identifier.",
"operationId": "fetch-subscription",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
},
"put": {
"tags": [
"Subscription"
],
"summary": "Update subscription",
"description": "This endpoint can be used to update the `metadata`, `net terms`, `auto_collection`, `invoicing_threshold`,\nand `default_invoice_memo` properties on a subscription.",
"operationId": "update-subscription",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateSubscriptionParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Subscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/cancel": {
"post": {
"tags": [
"Subscription"
],
"summary": "Cancel subscription",
"description": "This endpoint can be used to cancel an existing subscription. It returns the serialized subscription object with an\n`end_date` parameter that signifies when the subscription will transition to an ended state.\n\nThe body parameter `cancel_option` determines the cancellation behavior. Orb supports three cancellation options:\n- `end_of_subscription_term`: stops the subscription from auto-renewing. Subscriptions that have been cancelled with\n this option can still incur charges for the remainder of their term:\n - Issuing this cancellation request for a monthly subscription will keep the subscription active until the start\n of the subsequent month, and potentially issue an invoice for any usage charges incurred in the intervening\n period.\n - Issuing this cancellation request for a quarterly subscription will keep the subscription active until the end\n of the quarter and potentially issue an invoice for any usage charges incurred in the intervening period.\n - Issuing this cancellation request for a yearly subscription will keep the subscription active for the full\n year. For example, a yearly subscription starting on 2021-11-01 and cancelled on 2021-12-08 will remain active\n until 2022-11-01 and potentially issue charges in the intervening months for any recurring monthly usage\n charges in its plan.\n - **Note**: If a subscription's plan contains prices with difference cadences, the end of term date will be\n determined by the largest cadence value. For example, cancelling end of term for a subscription with a\n quarterly fixed fee with a monthly usage fee will result in the subscription ending at the end of the quarter.\n\n- `immediate`: ends the subscription immediately, setting the `end_date` to the current time:\n - Subscriptions that have been cancelled with this option will be invoiced immediately. This invoice will\n include any usage fees incurred in the billing period up to the cancellation, along with any prorated\n recurring fees for the billing period, if applicable.\n - **Note**: If the subscription has a recurring fee that was paid in-advance, the prorated amount for the\n remaining time period will be added to the [customer's balance](list-balance-transactions) upon immediate\n cancellation. However, if the customer is ineligible to use the customer balance, the subscription cannot be\n cancelled immediately.\n\n- `requested_date`: ends the subscription on a specified date, which requires a `cancellation_date` to be passed in.\n If no timezone is provided, the customer's timezone is used. For example, a subscription starting on January 1st\n with a monthly price can be set to be cancelled on the first of any month after January 1st (e.g. March 1st, April\n 1st, May 1st). A subscription with multiple prices with different cadences defines the \"term\" to be the highest\n cadence of the prices.\n\nUpcoming subscriptions are only eligible for immediate cancellation, which will set the `end_date` equal to the\n`start_date` upon cancellation.\n\n## Backdated cancellations\nOrb allows you to cancel a subscription in the past as long as there are no paid invoices between the\n`requested_date` and the current time. If the cancellation is after the latest issued invoice, Orb will generate a\nbalance refund for the current period. If the cancellation is before the most recently issued invoice, Orb will void\nthe intervening invoice and generate a new one based on the new dates for the subscription. See the section on\n[cancellation behaviors](/product-catalog/creating-subscriptions#cancellation-behaviors).",
"operationId": "cancel-subscription",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CancelSubscriptionParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/costs": {
"get": {
"tags": [
"Subscription"
],
"summary": "Fetch subscription costs",
"description": "This endpoint is used to fetch a day-by-day snapshot of a subscription's costs in Orb, calculated by applying\npricing information to the underlying usage (see the [subscription usage endpoint](fetch-subscription-usage) to\nfetch usage per metric, in usage units rather than a currency).\n\nThe semantics of this endpoint exactly mirror those of\n[fetching a customer's costs](/api-reference/customer/fetch-customer-costs).\nUse this endpoint to limit your analysis of costs to a specific subscription for the customer (e.g. to de-aggregate costs\nwhen a customer's subscription has started and stopped on the same day).",
"operationId": "fetch-subscription-costs",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Costs returned are inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"name": "timeframe_start",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Costs returned are exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"name": "timeframe_end",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"name": "view_mode",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use."
},
"name": "currency",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionCosts"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/price_intervals": {
"post": {
"tags": [
"Price interval"
],
"summary": "Add or edit price intervals",
"description": "This endpoint is used to add and edit subscription\n[price intervals](/api-reference/price-interval/add-or-edit-price-intervals). By making\nmodifications to a subscription\u2019s price intervals, you can [flexibly and atomically control the billing behavior of a\nsubscription](/product-catalog/modifying-subscriptions).\n\n## Adding price intervals\n\nPrices can be added as\nprice intervals to a subscription by specifying them in the `add` array. A `price_id` or `external_price_id` from an\nadd-on price or previously removed plan price can be specified to reuse an existing price definition (however, please\nnote that prices from other plans cannot be added to the subscription). Additionally, a new price can be specified using\nthe `price` field \u2014 this price will be created automatically.\n\nA `start_date` must be specified for the price\ninterval. This is the date when the price will start billing on the subscription, so this will notably result in an\nimmediate charge at this time for any billed in advance fixed fees. The `end_date` will default to null, resulting in a\nprice interval that will bill on a continually recurring basis. Both of these dates can be set in the past or the future\nand Orb will generate or modify invoices to ensure the subscription\u2019s invoicing behavior is correct.\n\nAdditionally, a\ndiscount, minimum, or maximum can be specified on the price interval. This will only apply to this price interval, not\nany other price intervals on the subscription.\n\n## Adjustment intervals\n\nAn adjustment interval represents the time period that a particular adjustment (a discount, minimum, or maximum) applies\nto the prices on a subscription. Adjustment intervals can be added to a subscription by specifying them in the\n`add_adjustments` array, or modified via the `edit_adjustments` array. When creating an adjustment interval, you'll need\nto provide the definition of the new adjustment (the type of adjustment, and which prices it applies to), as well as\nthe start and end dates for the adjustment interval. The start and end dates of an existing adjustment interval can be edited\nvia the `edit_adjustments` field (just like price intervals). (To \"change\" the amount of a discount, minimum, or maximum,\nthen, you'll need to end the existing interval, and create a new adjustment interval with the new amount and a start date\nthat matches the end date of the previous interval.)\n\n## Editing price intervals\n\nPrice intervals can be adjusted by\nspecifying edits to make in the `edit` array. A `price_interval_id` to edit must be specified \u2014 this can be retrieved\nfrom the `price_intervals` field on the subscription.\n\nA new `start_date` or `end_date` can be specified to change the\nrange of the price interval, which will modify past or future invoices to ensure correctness. If either of these dates\nare unspecified, they will default to the existing date on the price interval. To remove a price interval entirely from\na subscription, set the `end_date` to be equivalent to the `start_date`.\n\n## Fixed fee quantity transitions\nThe fixed fee quantity transitions for a fixed fee price interval can also be specified when adding or editing by passing an\narray for `fixed_fee_quantity_transitions`. A fixed fee quantity transition must have a `quantity` and an\n`effective_date`, which is the date after which the new quantity will be used for billing. If a fixed fee quantity\ntransition is scheduled at a billing period boundary, the full quantity will be billed on an invoice with the other\nprices on the subscription. If the fixed fee quantity transition is scheduled mid-billing period, the difference between\nthe existing quantity and quantity specified in the transition will be prorated for the rest of the billing period and\nbilled immediately, which will generate a new invoice.\n\nNotably, the list of fixed fee quantity transitions passed\nwill overwrite the existing fixed fee quantity transitions on the price interval, so the entire list of transitions must\nbe specified to add additional transitions. The existing list of transitions can be retrieved using the\n`fixed_fee_quantity_transitions` property on a subscription\u2019s serialized price intervals.",
"operationId": "add-edit-price-intervals",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AddEditPriceIntervalParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/redeem_coupon": {
"post": {
"tags": [
"Subscription"
],
"summary": "Redeem Coupon",
"description": "Redeem a coupon effective at a given time.",
"operationId": "redeem-coupon",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RedeemCouponParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/schedule": {
"get": {
"tags": [
"Subscription"
],
"summary": "Fetch subscription schedule",
"description": "This endpoint returns a [paginated](/api-reference/pagination) list of all plans associated with a subscription along\nwith their start and end dates. This list contains the subscription's initial plan along with past and future plan\nchanges.",
"operationId": "fetch-subscription-schedule",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"name": "limit",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"name": "cursor",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Gte]"
},
"name": "start_date[gte]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Gt]"
},
"name": "start_date[gt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Lt]"
},
"name": "start_date[lt]",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Lte]"
},
"name": "start_date[lte]",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionScheduleItems"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/schedule_plan_change": {
"post": {
"tags": [
"Subscription"
],
"summary": "Schedule plan change",
"description": "This endpoint can be used to change an existing subscription's plan. It returns the serialized updated subscription object.\n\nThe body parameter `change_option` determines when the plan change occurs. Orb supports three options:\n- `end_of_subscription_term`: changes the plan at the end of the existing plan's term.\n - Issuing this plan change request for a monthly subscription will keep the existing plan active until the start\n of the subsequent month. Issuing this plan change request for a yearly subscription will keep the existing plan active for\n the full year. Charges incurred in the remaining period will be invoiced as normal.\n - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be\n changed on February 1st, and invoice will be issued on February 1st for the last month of the original plan.\n- `immediate`: changes the plan immediately.\n - Subscriptions that have their plan changed with this option will move to the new plan immediately, and be invoiced\n immediately.\n - This invoice will include any usage fees incurred in the billing period up to the change, along with any prorated\n recurring fees for the billing period, if applicable.\n - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, so the plan will be\n changed on January 15th, and an invoice will be issued for the partial month, from January 1 to January 15, on the\n original plan.\n- `requested_date`: changes the plan on the requested date (`change_date`).\n - If no timezone is provided, the customer's timezone is used. The `change_date` body parameter is required if this option\n is chosen.\n - Example: The plan is billed monthly on the 1st of the month, the request is made on January 15th, with a requested\n `change_date` of February 15th, so the plan will be changed on February 15th, and invoices will be issued on February 1st\n and February 15th.\n\nNote that one of `plan_id` or `external_plan_id` is required in the request body for this operation.\n\n## Customize your customer's subscriptions\n\nPrices and adjustments in a plan can be added, removed, or replaced on the subscription when you schedule the plan change. This\nis useful when a customer has prices that differ from the default prices for a specific plan.\n\n\nThis feature is only available for accounts that have migrated to Subscription Overrides Version 2. You can find your\nSubscription Overrides Version at the bottom of your [Plans page](https://app.withorb.com/plans)\n\n\n### Adding Prices\n\nTo add prices, provide a list of objects with the key `add_prices`. An object in the list must specify an existing add-on price\nwith a `price_id` or `external_price_id` field, or create a new add-on price by including an object with the key `price`,\nidentical to what would be used in the request body for the [create price endpoint](/api-reference/price/create-price). See the\n[Price resource](/product-catalog/price-configuration) for the specification of different price model configurations possible\nin this object.\n\nIf the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the\nprice should be added to.\n\nAn object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start\nof the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have\nno end time.\n\nAn object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments\nwhich apply only to this price.\n\nAdditionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference this price when\n[adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to refer to\nthe price in future API calls.\n\n### Removing Prices\n\nTo remove prices, provide a list of objects with the key `remove_prices`. An object in the list must specify a plan price with\neither a `price_id` or `external_price_id` field.\n\n### Replacing Prices\n\nTo replace prices, provide a list of objects with the key `replace_prices`. An object in the list must specify a plan price to\nreplace with the `replaces_price_id` key, and it must specify a price to replace it with by either referencing an existing\nadd-on price with a `price_id` or `external_price_id` field, or by creating a new add-on price by including an object with the\nkey `price`, identical to what would be used in the request body for\nthe [create price endpoint](/api-reference/price/create-price).\nSee the [Price resource](/product-catalog/price-configuration) for the specification of different price model configurations\npossible in this object.\n\nFor fixed fees, an object in the list can supply a `fixed_price_quantity` instead of a `price`, `price_id`, or\n`external_price_id` field. This will update only the quantity for the price, similar to the\n[Update price quantity](/api-reference/subscription/update-price-quantity) endpoint.\n\nThe replacement price will have the same phase, if applicable, and the same start and end dates as the price it replaces.\n\nAn object in the list can specify an optional `minimum_amount`, `maximum_amount`, or `discounts`. This will create adjustments\nwhich apply only to this price.\n\nAdditionally, an object in the list can specify an optional `reference_id`. This ID can be used to reference the replacement\nprice when [adding an adjustment](#adding-adjustments) in the same API call. However the ID is _transient_ and cannot be used to\nrefer to the price in future API calls.\n\n### Adding adjustments\n\nTo add adjustments, provide a list of objects with the key `add_adjustments`. An object in the list must include an object with\nthe key `adjustment`, identical to the adjustment object in the\n[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).\n\nIf the plan has phases, each object in the list must include a number with `plan_phase_order` key to indicate which phase the\nadjustment should be added to.\n\nAn object in the list can specify an optional `start_date` and optional `end_date`. If `start_date` is unspecified, the start\nof the phase / plan change time will be used. If `end_date` is unspecified, it will finish at the end of the phase / have\nno end time.\n\n### Removing adjustments\n\nTo remove adjustments, provide a list of objects with the key `remove_adjustments`. An object in the list must include a key,\n`adjustment_id`, with the ID of the adjustment to be removed.\n\n### Replacing adjustments\n\nTo replace adjustments, provide a list of objects with the key `replace_adjustments`. An object in the list must specify a plan\nadjustment to replace with the `replaces_adjustment_id` key, and it must specify an adjustment to replace it with by including\nan object with the key `adjustment`, identical to the adjustment object in the\n[add/edit price intervals endpoint](/api-reference/price-interval/add-or-edit-price-intervals).\n\nThe replacement adjustment will have the same phase, if applicable, and the same start and end dates as the adjustment it\nreplaces.\n\n## Price overrides (DEPRECATED)\n\n\nPrice overrides are being phased out in favor adding/removing/replacing prices. (See\n[Customize your customer's subscriptions](/api-reference/subscription/schedule-plan-change))\n\n\nPrice overrides are used to update some or all prices in a plan for the specific subscription being created. This is\nuseful when a new customer has negotiated a rate that is unique to the customer.\n\nTo override prices, provide a list of objects with the key `price_overrides`. The price object in the list of overrides\nis expected to contain the existing price id, the `model_type` and configuration.\n(See the [Price resource](/product-catalog/price-configuration)\nfor the specification of different price model configurations.) The numerical values can be updated, but the billable metric,\ncadence, type, and name of a price can not be overridden.\n\n### Maximums, and minimums\nPrice overrides are used to update some or all prices in the target plan. Minimums and maximums, much like price\noverrides, can be useful when a new customer has negotiated a new or different minimum or maximum spend cap than the\ndefault for the plan. The request format for maximums and minimums is the same as those in\n[subscription creation](create-subscription).\n\n## Scheduling multiple plan changes\nWhen scheduling multiple plan changes with the same date, the latest plan change on that day takes effect.\n\n## Prorations for in-advance fees\nBy default, Orb calculates the prorated difference in any fixed fees when making a plan change, adjusting the\ncustomer balance as needed. For details on this behavior, see\n[Modifying subscriptions](/product-catalog/modifying-subscriptions#prorations-for-in-advance-fees).",
"operationId": "schedule-plan-change",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionPlanChange"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/trigger_phase": {
"post": {
"tags": [
"Subscription"
],
"summary": "Trigger phase",
"description": "Manually trigger a phase, effective the given date (or the current time, if not specified).",
"operationId": "trigger-phase",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TriggerSubscriptionPhaseParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/unschedule_cancellation": {
"post": {
"tags": [
"Subscription"
],
"summary": "Unschedule subscription cancellation",
"description": "This endpoint can be used to unschedule any pending cancellations for a subscription.\n\nTo be eligible, the subscription must currently be active and have a future cancellation. This operation will turn\non auto-renew, ensuring that the subscription does not end at the currently scheduled cancellation time.\n\nNote: uncancellation is a lossy operation. Price intervals that were cut short by the cancellation are extended\nto infinity (original end dates are lost), and future intervals or phases scheduled after the cancellation time\nare permanently deleted. For complex subscriptions with phases or scheduled plan changes, consider creating a new\nplan change instead of uncancelling.",
"operationId": "unschedule-cancellation",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/unschedule_fixed_fee_quantity_updates": {
"post": {
"tags": [
"Subscription"
],
"summary": "Unschedule fixed fee quantity updates",
"description": "This endpoint can be used to clear scheduled updates to the quantity for a fixed fee.\n\nIf there are no updates scheduled, a request validation error will be returned with a 400 status code.",
"operationId": "unschedule-fixed-fee-quantity",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnscheduleFixedFeeQuantityChangeParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/unschedule_pending_plan_changes": {
"post": {
"tags": [
"Subscription"
],
"summary": "Unschedule plan change",
"description": "This endpoint can be used to unschedule any pending plan changes on an existing subscription.\nWhen called, all upcoming plan changes will be unscheduled.",
"operationId": "unschedule-plan-change",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/update_fixed_fee_quantity": {
"post": {
"tags": [
"Subscription"
],
"summary": "Update price quantity",
"description": "This endpoint can be used to update the quantity for a fixed fee.\n\nTo be eligible, the subscription must currently be active and the price specified must be a fixed fee (not\nusage-based). This operation will immediately update the quantity for the fee, or if a `effective_date` is passed\nin, will update the quantity on the requested date at midnight in the customer's timezone.\n\nIn order to change the fixed fee quantity as of the next draft invoice for this subscription, pass\n`change_option=upcoming_invoice` without an `effective_date` specified.\n\nIf the fee is an in-advance fixed fee, it will also issue an immediate invoice for the difference for the remainder\nof the billing period.",
"operationId": "update-fixed-fee-quantity",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FixedFeeQuantityChange"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/update_trial": {
"post": {
"tags": [
"Subscription"
],
"summary": "Update trial for subscription",
"description": "This endpoint is used to update the trial end date for a subscription. The new trial end date must be within the time range\nof the current plan (i.e. the new trial end date must be on or after the subscription's start date on the current plan, and\non or before the subscription end date).\n\nIn order to retroactively remove a trial completely, the end date can be set to the transition date of the subscription to this\nplan (or, if this is the first plan for this subscription, the subscription's start date). In order to end a trial immediately,\nthe keyword `immediate` can be provided as the trial end date.\n\nBy default, Orb will shift only the trial end date (and price intervals that start or end on the previous trial end date), and\nleave all other future price intervals untouched. If the `shift` parameter is set to `true`, Orb will shift all subsequent\nprice and adjustment intervals by the same amount as the trial end date shift (so, e.g., if a plan change is scheduled or an\nadd-on price was added, that change will be pushed back by the same amount of time the trial is extended).",
"operationId": "update-trial",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UpdateTrialRequestParams"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MutatedSubscription"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
},
"/subscriptions/{subscription_id}/usage": {
"get": {
"tags": [
"Subscription"
],
"summary": "Fetch subscription usage",
"description": "This endpoint is used to fetch a subscription's usage in Orb. Especially when combined with optional query\nparameters, this endpoint is a powerful way to build visualizations on top of Orb's event data and metrics.\n\nWith no query parameters specified, this endpoint returns usage for the subscription's _current billing period_\nacross each billable metric that participates in the subscription. Usage quantities returned are the result of\nevaluating the metric definition for the entirety of the customer's billing period.\n\n### Default response shape\nOrb returns a `data` array with an object corresponding to each billable metric. Nested within this object is a\n`usage` array which has a `quantity` value and a corresponding `timeframe_start` and `timeframe_end`. The `quantity`\nvalue represents the calculated usage value for the billable metric over the specified timeframe (inclusive of the\n`timeframe_start` timestamp and exclusive of the `timeframe_end` timestamp).\n\nOrb will include _every_ window in the response starting from the beginning of the billing period, even when there\nwere no events (and therefore no usage) in the window. This increases the size of the response but prevents the caller\nfrom filling in gaps and handling cumbersome time-based logic.\n\nThe query parameters in this endpoint serve to override this behavior and provide some key functionality, as listed\nbelow. Note that this functionality can also be used _in conjunction_ with each other, e.g. to display grouped usage\non a custom timeframe.\n\n## Custom timeframe\nIn order to view usage for a custom timeframe rather than the current billing period, specify a `timeframe_start` and\n`timeframe_end`. This will calculate quantities for usage incurred between timeframe_start (inclusive) and timeframe_end\n(exclusive), i.e. `[timeframe_start, timeframe_end)`.\n\nNote:\n- These timestamps must be specified in ISO 8601 format and UTC timezone, e.g. `2022-02-01T05:00:00Z`.\n- Both parameters must be specified if either is specified.\n\n## Grouping by custom attributes\nIn order to view a single metric grouped by a specific _attribute_ that each event is tagged with (e.g. `cluster`), you\nmust additionally specify a `billable_metric_id` and a `group_by` key. The `group_by` key denotes the event property on\nwhich to group.\n\nWhen returning grouped usage, only usage for `billable_metric_id` is returned, and a separate object in the `data` array\nis returned for each value of the `group_by` key present in your events. The `quantity` value is the result of evaluating\nthe billable metric for events filtered to a single value of the `group_by` key.\n\nOrb expects that events that match the billable metric will contain values in the `properties` dictionary that correspond\nto the `group_by` key specified. By default, Orb will not return a `null` group (i.e. events that match the metric but\ndo not have the key set). Currently, it is only possible to view usage grouped by a single attribute at a time.\n\n When viewing grouped usage, Orb uses pagination to limit the response size to 1000 groups by default. If there are more\n groups for a given subscription, pagination metadata in the response can be used to fetch all of the data.\n\nThe following example shows usage for an \"API Requests\" billable metric grouped by `region`. Note the extra `metric_group`\ndictionary in the response, which provides metadata about the group:\n\n```json\n{\n \"data\": [\n {\n \"usage\": [\n {\n \"quantity\": 0.19291,\n \"timeframe_start\": \"2021-10-01T07:00:00Z\",\n \"timeframe_end\": \"2021-10-02T07:00:00Z\",\n },\n ...\n ],\n \"metric_group\": {\n \"property_key\": \"region\",\n \"property_value\": \"asia/pacific\"\n },\n \"billable_metric\": {\n \"id\": \"Fe9pbpMk86xpwdGB\",\n \"name\": \"API Requests\"\n },\n \"view_mode\": \"periodic\"\n },\n ...\n ]\n}\n```\n\n\n## Windowed usage\nThe `granularity` parameter can be used to _window_ the usage `quantity` value into periods. When not specified, usage\nis returned for the entirety of the time range.\n\nWhen `granularity = day` is specified with a timeframe longer than a day, Orb will return a `quantity` value for each\nfull day between `timeframe_start` and `timeframe_end`. Note that the days are demarcated by the _customer's local midnight_.\n\nFor example, with `timeframe_start = 2022-02-01T05:00:00Z`, `timeframe_end = 2022-02-04T01:00:00Z` and `granularity=day`,\nthe following windows will be returned for a customer in the `America/Los_Angeles` timezone since local midnight is `08:00` UTC:\n- `[2022-02-01T05:00:00Z, 2022-02-01T08:00:00Z)`\n- `[2022-02-01T08:00:00, 2022-02-02T08:00:00Z)`\n- `[2022-02-02T08:00:00, 2022-02-03T08:00:00Z)`\n- `[2022-02-03T08:00:00, 2022-02-04T01:00:00Z)`\n\n```json\n{\n \"data\": [\n {\n \"billable_metric\": {\n \"id\": \"Q8w89wjTtBdejXKsm\",\n \"name\": \"API Requests\"\n },\n \"usage\": [\n {\n \"quantity\": 0,\n \"timeframe_end\": \"2022-02-01T08:00:00+00:00\",\n \"timeframe_start\": \"2022-02-01T05:00:00+00:00\"\n },\n {\n\n \"quantity\": 0,\n \"timeframe_end\": \"2022-02-02T08:00:00+00:00\",\n \"timeframe_start\": \"2022-02-01T08:00:00+00:00\"\n },\n {\n \"quantity\": 0,\n \"timeframe_end\": \"2022-02-03T08:00:00+00:00\",\n \"timeframe_start\": \"2022-02-02T08:00:00+00:00\"\n },\n {\n \"quantity\": 0,\n \"timeframe_end\": \"2022-02-04T01:00:00+00:00\",\n \"timeframe_start\": \"2022-02-03T08:00:00+00:00\"\n }\n ],\n \"view_mode\": \"periodic\"\n },\n ...\n ]\n}\n```\n\n## Decomposable vs. non-decomposable metrics\nBillable metrics fall into one of two categories: decomposable and non-decomposable. A decomposable billable metric, such as\na sum or a count, can be displayed and aggregated across arbitrary timescales. On the other hand, a non-decomposable metric\nis not meaningful when only a slice of the billing window is considered.\n\nAs an example, if we have a billable metric that's defined to count unique users, displaying a graph of unique users for each\nday is not representative of the billable metric value over the month (days could have an overlapping set of 'unique' users).\nInstead, what's useful for any given day is the number of unique users in the billing period so far, which are the\n_cumulative_ unique users.\n\nAccordingly, this endpoint returns treats these two types of metrics differently when `group_by` is specified:\n- Decomposable metrics can be grouped by any event property.\n- Non-decomposable metrics can only be grouped by the corresponding price's invoice grouping key. If no invoice grouping key\nis present, the metric does not support `group_by`.\n\n## Matrix prices\nWhen a billable metric is attached to a price that uses matrix pricing, it's important to view usage grouped by those matrix\ndimensions. In this case, use the query parameters `first_dimension_key`, `first_dimension_value` and `second_dimension_key`,\n`second_dimension_value` while filtering to a specific `billable_metric_id`.\n\nFor example, if your compute metric has a separate unit price (i.e. a matrix pricing model) per `region` and `provider`,\nyour request might provide the following parameters:\n\n- `first_dimension_key`: `region`\n- `first_dimension_value`: `us-east-1`\n- `second_dimension_key`: `provider`\n- `second_dimension_value`: `aws`",
"operationId": "fetch-subscription-usage",
"parameters": [
{
"required": true,
"style": "simple",
"schema": {
"type": "string"
},
"name": "subscription_id",
"in": "path"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"day"
]
},
{
"type": "null"
}
],
"title": "Granularity",
"description": "This determines the windowing of usage reporting.",
"default": "day"
},
"name": "granularity",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Usage returned is inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"name": "timeframe_start",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Usage returned is exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"name": "timeframe_end",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "When specified in conjunction with `group_by`, this parameter filters usage to a single billable metric. Note that both `group_by` and `billable_metric_id` must be specified together."
},
"name": "billable_metric_id",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "Groups per-price usage by the key provided."
},
"name": "group_by",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative usage since the start of the billing period, or incremental day-by-day usage. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"name": "view_mode",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Dimension Key"
},
"name": "first_dimension_key",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Dimension Value"
},
"name": "first_dimension_value",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Key"
},
"name": "second_dimension_key",
"in": "query"
},
{
"required": false,
"style": "form",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Value"
},
"name": "second_dimension_value",
"in": "query"
}
],
"responses": {
"200": {
"description": "OK",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SubscriptionUsage"
}
}
}
},
"400": {
"description": "Bad Request",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400Error"
}
}
}
},
"401": {
"description": "Unauthorized",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/401Error"
}
}
}
},
"404": {
"description": "Not Found",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/404Error"
}
}
}
},
"409": {
"description": "Conflict",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/409Error"
}
}
}
},
"413": {
"description": "Content Too Large",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/413Error"
}
}
}
},
"429": {
"description": "Too Many Requests",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/429Error"
}
}
}
},
"500": {
"description": "Internal Server Error",
"headers": {},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/500Error"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"400Error": {
"oneOf": [
{
"$ref": "#/components/schemas/ConstraintViolationError"
},
{
"$ref": "#/components/schemas/DuplicateResourceCreationError"
},
{
"$ref": "#/components/schemas/RequestValidationError"
}
]
},
"401Error": {
"$ref": "#/components/schemas/AuthorizationError",
"title": "401Error"
},
"404Error": {
"oneOf": [
{
"$ref": "#/components/schemas/FeatureNotAvailableError"
},
{
"$ref": "#/components/schemas/ResourceNotFoundError"
},
{
"$ref": "#/components/schemas/URLNotFound"
}
]
},
"409Error": {
"$ref": "#/components/schemas/IdempotencyRequestMismatch",
"title": "409Error"
},
"413Error": {
"oneOf": [
{
"$ref": "#/components/schemas/RequestTooLargeError"
},
{
"$ref": "#/components/schemas/ResourceTooLargeError"
},
{
"$ref": "#/components/schemas/TooManyResultsError"
}
]
},
"429Error": {
"$ref": "#/components/schemas/TooManyRequests",
"title": "429Error"
},
"500Error": {
"$ref": "#/components/schemas/ServerError",
"title": "500Error"
},
"AccountingProvider": {
"properties": {
"provider_type": {
"type": "string",
"enum": [
"quickbooks",
"netsuite"
],
"title": "Provider Type"
},
"external_provider_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Provider Id"
}
},
"type": "object",
"required": [
"provider_type",
"external_provider_id"
],
"title": "AccountingProvider"
},
"AccountingProviderConfig": {
"properties": {
"provider_type": {
"type": "string",
"enum": [
"quickbooks",
"netsuite"
],
"title": "Provider Type"
},
"external_provider_id": {
"type": "string",
"title": "External Provider Id"
}
},
"type": "object",
"required": [
"provider_type",
"external_provider_id"
],
"title": "AccountingProviderConfig"
},
"AccountingSyncConfiguration": {
"properties": {
"excluded": {
"type": "boolean",
"title": "Excluded"
},
"accounting_providers": {
"items": {
"$ref": "#/components/schemas/AccountingProvider"
},
"type": "array",
"title": "Accounting Providers"
}
},
"type": "object",
"required": [
"excluded",
"accounting_providers"
],
"title": "AccountingSyncConfiguration"
},
"AddAdjustmentIntervalParams": {
"properties": {
"adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Adjustment Id",
"description": "The ID of the adjustment to add to the subscription. Adjustment IDs can be re-used from existing subscriptions or plans, but adjustments associated with coupon redemptions cannot be re-used.",
"examples": [
"h74gfhdjvn7ujokd"
]
},
"adjustment": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAdjustment"
},
{
"type": "null"
}
],
"description": "The definition of a new adjustment to create and add to the subscription."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
}
],
"title": "Start Date",
"description": "The start date of the adjustment interval. This is the date that the adjustment will start affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this `start_date`. This `start_date` is treated as inclusive for in-advance prices, and exclusive for in-arrears prices.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the adjustment interval. This is the date that the adjustment will stop affecting prices on the subscription. The adjustment will apply to invoice dates that overlap with this `end_date`.This `end_date` is treated as exclusive for in-advance prices, and inclusive for in-arrears prices.",
"examples": [
"2023-07-10"
]
}
},
"type": "object",
"required": [
"start_date"
],
"title": "AddAdjustmentIntervalParams"
},
"AddAmendmentCreditLedgerEntryRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use for this ledger entry. If this is a real-world currency, it must match the customer's invoicing currency."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc."
},
"entry_type": {
"type": "string",
"enum": [
"amendment"
],
"title": "Entry Type"
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The number of credits to effect. Note that this is required for increment, decrement or void operations."
},
"block_id": {
"type": "string",
"title": "Block Id",
"description": "The ID of the block to reverse a decrement from."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"entry_type",
"amount",
"block_id"
],
"title": "AddAmendmentCreditLedgerEntryRequestParams"
},
"AddCreditLedgerEntryRequestParams": {
"oneOf": [
{
"$ref": "#/components/schemas/AddIncrementCreditLedgerEntryRequestParams"
},
{
"$ref": "#/components/schemas/AddDecrementCreditLedgerEntryRequestParams"
},
{
"$ref": "#/components/schemas/AddExpirationChangeCreditLedgerEntryRequestParams"
},
{
"$ref": "#/components/schemas/AddVoidCreditLedgerEntryRequestParams"
},
{
"$ref": "#/components/schemas/AddAmendmentCreditLedgerEntryRequestParams"
}
],
"discriminator": {
"propertyName": "entry_type",
"mapping": {
"amendment": "#/components/schemas/AddAmendmentCreditLedgerEntryRequestParams",
"decrement": "#/components/schemas/AddDecrementCreditLedgerEntryRequestParams",
"expiration_change": "#/components/schemas/AddExpirationChangeCreditLedgerEntryRequestParams",
"increment": "#/components/schemas/AddIncrementCreditLedgerEntryRequestParams",
"void": "#/components/schemas/AddVoidCreditLedgerEntryRequestParams"
}
}
},
"AddCreditTopUpRequestParams": {
"properties": {
"currency": {
"type": "string",
"title": "Currency",
"description": "The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer's invoicing currency."
},
"threshold": {
"type": "string",
"title": "Threshold",
"description": "The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount to increment when the threshold is reached."
},
"per_unit_cost_basis": {
"type": "string",
"title": "Per Unit Cost Basis",
"description": "How much, in the customer's currency, to charge for each unit."
},
"invoice_settings": {
"$ref": "#/components/schemas/NewTopUpInvoiceSettings",
"description": "Settings for invoices generated by triggered top-ups."
},
"expires_after": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expires After",
"description": "The number of days or months after which the top-up expires. If unspecified, it does not expire."
},
"expires_after_unit": {
"oneOf": [
{
"type": "string",
"enum": [
"day",
"month"
]
},
{
"type": "null"
}
],
"title": "Expires After Unit",
"description": "The unit of expires_after."
},
"active_from": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Active From",
"description": "The date from which the top-up is active. If unspecified, the top-up is active immediately. This should not be more than 10 days in the past."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"currency",
"threshold",
"amount",
"per_unit_cost_basis",
"invoice_settings"
],
"title": "AddCreditTopUpRequestParams"
},
"AddDecrementCreditLedgerEntryRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use for this ledger entry. If this is a real-world currency, it must match the customer's invoicing currency."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc."
},
"entry_type": {
"type": "string",
"enum": [
"decrement"
],
"title": "Entry Type"
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"entry_type",
"amount"
],
"title": "AddDecrementCreditLedgerEntryRequestParams"
},
"AddEditPriceIntervalParams": {
"properties": {
"add": {
"items": {
"$ref": "#/components/schemas/AddPriceIntervalParams"
},
"type": "array",
"title": "Add",
"description": "A list of price intervals to add to the subscription."
},
"edit": {
"items": {
"$ref": "#/components/schemas/EditPriceIntervalParams"
},
"type": "array",
"title": "Edit",
"description": "A list of price intervals to edit on the subscription."
},
"add_adjustments": {
"items": {
"$ref": "#/components/schemas/AddAdjustmentIntervalParams"
},
"type": "array",
"title": "Add Adjustments",
"description": "A list of adjustments to add to the subscription."
},
"edit_adjustments": {
"items": {
"$ref": "#/components/schemas/EditAdjustmentIntervalParams"
},
"type": "array",
"title": "Edit Adjustments",
"description": "A list of adjustments to edit on the subscription."
},
"can_defer_billing": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Can Defer Billing",
"description": "If set, the default value to use for added/edited price intervals with an end_date set."
},
"allow_invoice_credit_or_void": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Invoice Credit Or Void",
"description": "If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"title": "AddEditPriceIntervalParams"
},
"AddExpirationChangeCreditLedgerEntryRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use for this ledger entry. If this is a real-world currency, it must match the customer's invoicing currency."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc."
},
"entry_type": {
"type": "string",
"enum": [
"expiration_change"
],
"title": "Entry Type"
},
"amount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Amount",
"description": "The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations."
},
"expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Expiry Date",
"description": "An ISO 8601 format date that identifies the origination credit block to expire"
},
"block_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Block Id",
"description": "The ID of the block affected by an expiration_change, used to differentiate between multiple blocks with the same `expiry_date`."
},
"target_expiry_date": {
"type": "string",
"format": "date",
"title": "Target Expiry Date",
"description": "A date (specified in YYYY-MM-DD format) used for expiration change, denoting when credits transferred (as part of a partial block expiration) should expire. This date must be on or after the effective date of the credit block."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"entry_type",
"target_expiry_date"
],
"title": "AddExpirationChangeCreditLedgerEntryRequestParams"
},
"AddIncrementCreditLedgerEntryRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use for this ledger entry. If this is a real-world currency, it must match the customer's invoicing currency."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc."
},
"entry_type": {
"type": "string",
"enum": [
"increment"
],
"title": "Entry Type"
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations."
},
"expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Expiry Date",
"description": "An ISO 8601 format date that denotes when this credit balance should expire."
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date",
"description": "An ISO 8601 format date that denotes when this credit balance should become available for use."
},
"per_unit_cost_basis": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Per Unit Cost Basis",
"description": "Can only be specified when entry_type=increment. How much, in the customer's currency, a customer paid for a single credit in this block"
},
"invoice_settings": {
"oneOf": [
{
"$ref": "#/components/schemas/IncrementCreditLedgerEntryInvoiceSettings"
},
{
"type": "null"
}
],
"description": "Passing `invoice_settings` automatically generates an invoice for the newly added credits. If `invoice_settings` is passed, you must specify per_unit_cost_basis, as the calculation of the invoice total is done on that basis."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/BlockPriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "Optional filter to specify which items this credit block applies to. If not specified, the block will apply to all items for the pricing unit."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"entry_type",
"amount"
],
"title": "AddIncrementCreditLedgerEntryRequestParams"
},
"AddPlanAdjustmentParams": {
"properties": {
"adjustment": {
"$ref": "#/components/schemas/NewAdjustment",
"description": "The definition of a new adjustment to create and add to the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to add this adjustment to."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"adjustment"
],
"title": "AddPlanAdjustmentParams"
},
"AddPlanPriceParams": {
"properties": {
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewPlanPrice"
},
{
"type": "null"
}
],
"description": "The price to add to the plan"
},
"allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAllocationPrice"
},
{
"type": "null"
}
],
"description": "The allocation price to add to the plan."
},
"license_allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewLicenseAllocationPrice"
},
{
"type": "null"
}
],
"description": "The license allocation price to add to the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to add this price to."
}
},
"additionalProperties": false,
"type": "object",
"title": "AddPlanPriceParams"
},
"AddPriceIntervalParams": {
"properties": {
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer's customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer's children."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.",
"examples": [
"my_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The id of the price to add to the subscription.",
"examples": [
"h74gfhdjvn7ujokd"
]
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external price id of the price to add to the subscription.",
"examples": [
"external_price_id"
]
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewFloatingPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new price to create and add to the subscription."
},
"allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAllocationPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new allocation price to create and add to the subscription."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
}
],
"title": "Start Date",
"description": "The start date of the price interval. This is the date that the price will start billing on the subscription.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the price interval. This is the date that the price will stop billing on the subscription.",
"examples": [
"2023-07-10"
]
},
"can_defer_billing": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Can Defer Billing",
"description": "If true, an in-arrears price interval ending mid-cycle will defer billing the final line item until the next scheduled invoice. If false, it will be billed on its end date."
},
"fixed_fee_quantity_transitions": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceIntervalFixedFeeQuantityTransitionParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fixed Fee Quantity Transitions",
"description": "A list of fixed fee quantity transitions to initialize on the price interval."
},
"discounts": {
"oneOf": [
{
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AmountDiscountCreationParams"
},
{
"$ref": "#/components/schemas/PercentageDiscountCreationParams"
},
{
"$ref": "#/components/schemas/UsageDiscountCreationParams"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscountCreationParams",
"percentage": "#/components/schemas/PercentageDiscountCreationParams",
"usage": "#/components/schemas/UsageDiscountCreationParams"
}
}
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Discounts",
"description": "A list of discounts to initialize on the price interval."
},
"minimum_amount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"description": "The minimum amount that will be billed for this price interval for a given billing period.",
"examples": [
"1.23"
]
},
"maximum_amount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"description": "The maximum amount that will be billed for this price interval for a given billing period.",
"examples": [
"1.23"
]
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Override values for parameterized billable metric variables. Keys are parameter names, values are the override values (number or string)."
}
},
"type": "object",
"required": [
"start_date"
],
"title": "AddPriceIntervalParams"
},
"AddSubscriptionAdjustmentParams": {
"properties": {
"adjustment": {
"$ref": "#/components/schemas/NewAdjustment",
"description": "The definition of a new adjustment to create and add to the subscription."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "The start date of the adjustment interval. This is the date that the adjustment will start affecting prices on the subscription. If null, the adjustment will start when the phase or subscription starts.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the adjustment interval. This is the date that the adjustment will stop affecting prices on the subscription.",
"examples": [
"2023-07-10"
]
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to add this adjustment to."
}
},
"type": "object",
"required": [
"adjustment"
],
"title": "AddSubscriptionAdjustmentParams"
},
"AddSubscriptionPriceParams": {
"properties": {
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The id of the price to add to the subscription.",
"examples": [
"h74gfhdjvn7ujokd"
]
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external price id of the price to add to the subscription.",
"examples": [
"external_price_id"
]
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewSubscriptionPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new price to create and add to the subscription."
},
"allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAllocationPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new allocation price to create and add to the subscription."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "The start date of the price interval. This is the date that the price will start billing on the subscription. If null, billing will start when the phase or subscription starts.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the price interval. This is the date that the price will stop billing on the subscription. If null, billing will end when the phase or subscription ends.",
"examples": [
"2023-07-10"
]
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to add this price to."
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for this price.",
"deprecated": true,
"examples": [
"1.23"
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for this price.",
"deprecated": true,
"examples": [
"1.23"
]
},
"discounts": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/DiscountOverride"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Discounts",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's discounts for this price.",
"deprecated": true
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Override values for parameterized billable metric variables. Keys are parameter names, values are the override values."
}
},
"type": "object",
"title": "AddSubscriptionPriceParams"
},
"AddVoidCreditLedgerEntryRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use for this ledger entry. If this is a real-world currency, it must match the customer's invoicing currency."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Optional metadata that can be specified when adding ledger results via the API. For example, this can be used to note an increment refers to trial credits, or for noting corrections as a result of an incident, etc."
},
"entry_type": {
"type": "string",
"enum": [
"void"
],
"title": "Entry Type"
},
"block_id": {
"type": "string",
"title": "Block Id",
"description": "The ID of the block to void."
},
"void_reason": {
"oneOf": [
{
"type": "string",
"enum": [
"refund"
]
},
{
"type": "null"
}
],
"title": "Void Reason",
"description": "Can only be specified when `entry_type=void`. The reason for the void."
},
"amount": {
"type": "number",
"title": "Amount",
"description": "The number of credits to effect. Note that this is required for increment, decrement, void, or undo operations."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"entry_type",
"block_id",
"amount"
],
"title": "AddVoidCreditLedgerEntryRequestParams"
},
"Address": {
"properties": {
"line1": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line1"
},
"line2": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line2"
},
"city": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City"
},
"state": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
},
"postal_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Postal Code"
},
"country": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
}
},
"type": "object",
"required": [
"line1",
"line2",
"city",
"state",
"postal_code",
"country"
],
"title": "Address"
},
"AddressInput": {
"properties": {
"line1": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line1"
},
"line2": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Line2"
},
"city": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "City"
},
"state": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "State"
},
"postal_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Postal Code"
},
"country": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Country"
}
},
"type": "object",
"title": "AddressInput"
},
"Adjustment": {
"oneOf": [
{
"$ref": "#/components/schemas/PlanPhaseUsageDiscountAdjustment"
},
{
"$ref": "#/components/schemas/PlanPhaseAmountDiscountAdjustment"
},
{
"$ref": "#/components/schemas/PlanPhasePercentageDiscountAdjustment"
},
{
"$ref": "#/components/schemas/PlanPhaseMinimumAdjustment"
},
{
"$ref": "#/components/schemas/PlanPhaseMaximumAdjustment"
}
],
"discriminator": {
"propertyName": "adjustment_type",
"mapping": {
"amount_discount": "#/components/schemas/PlanPhaseAmountDiscountAdjustment",
"maximum": "#/components/schemas/PlanPhaseMaximumAdjustment",
"minimum": "#/components/schemas/PlanPhaseMinimumAdjustment",
"percentage_discount": "#/components/schemas/PlanPhasePercentageDiscountAdjustment",
"usage_discount": "#/components/schemas/PlanPhaseUsageDiscountAdjustment"
}
}
},
"AdjustmentInterval": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"adjustment": {
"$ref": "#/components/schemas/Adjustment"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the adjustment interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the adjustment interval."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval IDs that this adjustment applies to."
}
},
"type": "object",
"required": [
"id",
"adjustment",
"start_date",
"end_date",
"applies_to_price_interval_ids"
],
"title": "AdjustmentInterval"
},
"AffectedBlock": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expiry Date"
},
"per_unit_cost_basis": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Per Unit Cost Basis"
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters"
}
},
"type": "object",
"required": [
"id",
"expiry_date",
"per_unit_cost_basis",
"filters"
],
"title": "AffectedBlock"
},
"AggregatedCost": {
"properties": {
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "Total costs for the timeframe, excluding any minimums and discounts."
},
"total": {
"type": "string",
"title": "Total",
"description": "Total costs for the timeframe, including any minimums and discounts."
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End"
},
"per_price_costs": {
"items": {
"$ref": "#/components/schemas/PerPriceCost"
},
"type": "array",
"title": "Per Price Costs"
}
},
"type": "object",
"required": [
"subtotal",
"total",
"timeframe_start",
"timeframe_end",
"per_price_costs"
],
"title": "AggregatedCost"
},
"Alert": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "Also referred to as alert_id in this documentation.",
"examples": [
"XuxCbt7x9L82yyeF"
]
},
"type": {
"oneOf": [
{
"type": "string",
"enum": [
"credit_balance_depleted",
"credit_balance_dropped",
"credit_balance_recovered"
]
},
{
"type": "string",
"enum": [
"usage_exceeded",
"cost_exceeded"
]
},
{
"type": "string",
"enum": [
"license_balance_threshold_reached"
]
}
],
"title": "Type",
"description": "The type of alert. This must be a valid alert type.",
"examples": [
"\"usage_exceeded\", \"cost_exceeded\", \"credit_balance_depleted\", \"credit_balance_recovered\", or \"credit_balance_dropped\""
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb."
},
"enabled": {
"type": "boolean",
"title": "Enabled",
"description": "Whether the alert is enabled or disabled."
},
"thresholds": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Thresholds",
"description": "The thresholds that define the conditions under which the alert will be triggered."
},
"customer": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerMinified"
},
{
"type": "null"
}
],
"description": "The customer the alert applies to."
},
"plan": {
"oneOf": [
{
"$ref": "#/components/schemas/PlanMinifiedWithVersion"
},
{
"type": "null"
}
],
"description": "The plan the alert applies to."
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
],
"description": "The subscription the alert applies to."
},
"metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricMinified"
},
{
"type": "null"
}
],
"description": "The metric the alert applies to."
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseTypeMinified"
},
{
"type": "null"
}
],
"description": "The license type the alert applies to. Only present for license alerts."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The name of the currency the credit balance or invoice cost is denominated in."
},
"grouping_keys": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grouping Keys",
"description": "The property keys to group cost alerts by. Only present for cost alerts with grouping enabled."
},
"price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Price Filters",
"description": "Filters scoping which prices are included in grouped cost alert evaluation."
},
"threshold_overrides": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ThresholdOverride"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Threshold Overrides",
"description": "Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a replacement threshold list. Only present for grouped cost alerts that have at least one override."
},
"balance_alert_status": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/BalanceAlertStatus"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Balance Alert Status",
"description": "The current status of the alert. This field is only present for credit balance alerts."
}
},
"type": "object",
"required": [
"id",
"type",
"created_at",
"enabled",
"thresholds",
"customer",
"plan",
"subscription",
"metric",
"currency"
],
"title": "Alert",
"description": "[Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,\nusage, or credit balance and trigger webhooks when a threshold is exceeded.\n\nAlerts created through the API can be scoped to either customers or subscriptions."
},
"Alerts": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Alert"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Alerts"
},
"Allocation": {
"properties": {
"currency": {
"type": "string",
"title": "Currency"
},
"allows_rollover": {
"type": "boolean",
"title": "Allows Rollover"
},
"custom_expiration": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomExpiration"
},
{
"type": "null"
}
]
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id"
}
},
"type": "object",
"required": [
"currency",
"allows_rollover",
"custom_expiration"
],
"title": "Allocation"
},
"AmendEventResult": {
"properties": {
"amended": {
"type": "string",
"title": "Amended",
"description": "event_id of the amended event, if successfully ingested"
}
},
"type": "object",
"required": [
"amended"
],
"title": "AmendEventResult"
},
"AmendedEvent": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb Customer identifier"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An alias for the Orb customer, whose mapping is specified when creating the customer"
},
"event_name": {
"type": "string",
"title": "Event Name",
"description": "A name to meaningfully identify the action or event type."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.",
"examples": [
"2020-12-09T16:09:53Z"
]
},
"properties": {
"additionalProperties": true,
"type": "object",
"title": "Properties",
"description": "A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"event_name",
"timestamp",
"properties"
],
"title": "AmendedEvent"
},
"AmendmentLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"amendment"
],
"title": "Entry Type"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type"
],
"title": "AmendmentLedgerEntry"
},
"AmountDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"amount"
],
"title": "Discount Type"
},
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.",
"examples": [
[
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
]
]
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "The filters that determine which prices to apply this discount to."
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount",
"description": "Only available if discount_type is `amount`."
}
},
"type": "object",
"required": [
"discount_type",
"amount_discount"
],
"title": "AmountDiscount"
},
"AmountDiscountCreationParams": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"amount"
],
"title": "Discount Type"
},
"amount_discount": {
"type": "number",
"minimum": 0.0,
"title": "Amount Discount",
"description": "Only available if discount_type is `amount`.",
"examples": [
"10.00"
]
}
},
"type": "object",
"required": [
"discount_type",
"amount_discount"
],
"title": "AmountDiscountCreationParams"
},
"AmountDiscountInterval": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"amount"
],
"title": "Discount Type"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount",
"description": "Only available if discount_type is `amount`."
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the discount interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the discount interval."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices this discount interval applies to."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval ids that this discount interval applies to."
}
},
"type": "object",
"required": [
"discount_type",
"amount_discount",
"start_date",
"end_date",
"filters",
"applies_to_price_interval_ids"
],
"title": "AmountDiscountInterval"
},
"ApiPaginationParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
}
},
"additionalProperties": false,
"type": "object",
"title": "ApiPaginationParams"
},
"ApplyParams": {
"properties": {
"previously_collected_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Previously Collected Amount",
"description": "Amount already collected to apply to the customer's balance. If mark_as_paid is also provided, credit the difference to the customer's balance."
},
"mark_as_paid": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Mark As Paid",
"description": "Mark all pending invoices that are payable as paid. If amount is also provided, mark as paid and credit the difference to the customer's balance."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "Description to apply to the balance transaction representing this credit."
},
"payment_received_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Payment Received Date",
"description": "A date string to specify the date the payment was received. Only applicable when mark_as_paid is true. If not provided, defaults to the current date."
},
"payment_external_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment External Id",
"description": "An optional external ID to associate with the payment. Only applicable when mark_as_paid is true."
},
"payment_notes": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Notes",
"description": "Optional notes about the payment. Only applicable when mark_as_paid is true."
}
},
"additionalProperties": false,
"type": "object",
"title": "ApplyParams"
},
"AuthorizationError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#401-authentication-error"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
401
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "AuthorizationError"
},
"AutoCollection": {
"properties": {
"next_attempt_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Next Attempt At",
"description": "If the invoice is scheduled for auto-collection, this field will reflect when the next attempt will occur. If dunning has been exhausted, or auto-collection is not enabled for this invoice, this field will be `null`."
},
"previously_attempted_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Previously Attempted At",
"description": "If Orb has ever attempted payment auto-collection for this invoice, this field will reflect when that attempt occurred. In conjunction with `next_attempt_at`, this can be used to tell whether the invoice is currently in dunning (that is, `previously_attempted_at` is non-null, and `next_attempt_time` is non-null), or if dunning has been exhausted (`previously_attempted_at` is non-null, but `next_attempt_time` is null)."
},
"enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Enabled",
"description": "True only if auto-collection is enabled for this invoice."
},
"num_attempts": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Num Attempts",
"description": "Number of auto-collection payment attempts."
}
},
"type": "object",
"required": [
"next_attempt_at",
"previously_attempted_at",
"enabled",
"num_attempts"
],
"title": "AutoCollection"
},
"Backfill": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"status": {
"$ref": "#/components/schemas/BackfillStatus"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End"
},
"events_ingested": {
"type": "integer",
"title": "Events Ingested",
"description": "The number of events ingested in this backfill."
},
"close_time": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Close Time",
"description": "If in the future, the time at which the backfill will automatically close. If in the past, the time at which the backfill was closed."
},
"reverted_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Reverted At",
"description": "The time at which this backfill was reverted."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb-generated ID of the customer to which this backfill is scoped. If `null`, this backfill is scoped to all customers."
},
"deprecation_filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deprecation Filter",
"description": "A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the set of events to deprecate",
"examples": [
"my_numeric_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"replace_existing_events": {
"type": "boolean",
"title": "Replace Existing Events",
"description": "If `true`, existing events in the backfill's timeframe will be replaced with the newly ingested events associated with the backfill. If `false`, newly ingested events will be added to the existing events."
}
},
"type": "object",
"required": [
"id",
"status",
"created_at",
"timeframe_start",
"timeframe_end",
"events_ingested",
"close_time",
"reverted_at",
"customer_id",
"replace_existing_events"
],
"title": "Backfill",
"description": "A backfill represents an update to historical usage data, adding or replacing events in a timeframe."
},
"BackfillStatus": {
"type": "string",
"enum": [
"pending",
"reflected",
"pending_revert",
"reverted"
],
"title": "BackfillStatus",
"description": "The status of the backfill."
},
"Backfills": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Backfill"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Backfills"
},
"BalanceAlertStatus": {
"properties": {
"threshold_value": {
"type": "number",
"title": "Threshold Value",
"description": "The value of the threshold that defines the alert status."
},
"in_alert": {
"type": "boolean",
"title": "In Alert",
"description": "Whether the alert is currently in-alert or not."
}
},
"type": "object",
"required": [
"threshold_value",
"in_alert"
],
"title": "BalanceAlertStatus",
"description": "Alert status is used to determine if an alert is currently in-alert or not."
},
"BillableMetric": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"status": {
"type": "string",
"enum": [
"active",
"draft",
"archived"
],
"title": "Status"
},
"item": {
"$ref": "#/components/schemas/Item"
},
"parameter_definitions": {
"oneOf": [
{
"items": {
"additionalProperties": true,
"type": "object"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Parameter Definitions"
}
},
"type": "object",
"required": [
"metadata",
"id",
"name",
"description",
"status",
"item"
],
"title": "BillableMetric",
"description": "The Metric resource represents a calculation of a quantity based on events.\nMetrics are defined by the query that transforms raw usage events into meaningful values for your customers."
},
"BillableMetricMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "BillableMetricMinified"
},
"BillableMetricSimple": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "BillableMetricSimple"
},
"BillableMetricTiny": {
"properties": {
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "BillableMetricTiny"
},
"BillableMetrics": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/BillableMetric"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "BillableMetrics"
},
"BillingCycleAnchorConfiguration": {
"properties": {
"day": {
"type": "integer",
"maximum": 31.0,
"minimum": 1.0,
"title": "Day",
"description": "The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th."
},
"month": {
"oneOf": [
{
"type": "integer",
"maximum": 12.0,
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Month",
"description": "The month on which the billing cycle is anchored (e.g. a quarterly price anchored in February would have cycles starting February, May, August, and November)."
},
"year": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Year",
"description": "The year on which the billing cycle is anchored (e.g. a 2 year billing cycle anchored on 2021 would have cycles starting on 2021, 2023, 2025, etc.)."
}
},
"type": "object",
"required": [
"day"
],
"title": "BillingCycleAnchorConfiguration"
},
"BillingCycleConfiguration": {
"properties": {
"duration": {
"type": "integer",
"title": "Duration"
},
"duration_unit": {
"type": "string",
"enum": [
"day",
"month"
],
"title": "Duration Unit"
}
},
"type": "object",
"required": [
"duration",
"duration_unit"
],
"title": "BillingCycleConfiguration"
},
"BlockPriceFilter": {
"properties": {
"field": {
"type": "string",
"enum": [
"item_id"
],
"title": "Field",
"description": "The property of the price the block applies to. Only item_id is supported."
},
"operator": {
"type": "string",
"enum": [
"includes",
"excludes"
],
"title": "Operator",
"description": "Should prices that match the filter be included or excluded."
},
"values": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Values",
"description": "The IDs or values that match this filter."
}
},
"type": "object",
"required": [
"field",
"operator",
"values"
],
"title": "BlockPriceFilter",
"description": "A PriceFilter that only allows item_id field for block filters."
},
"BulkConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/BulkTier"
},
"type": "array",
"minItems": 1,
"title": "Tiers",
"description": "Bulk tiers for rating based on total usage volume"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "BulkConfig",
"description": "Configuration for bulk pricing"
},
"BulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_config": {
"$ref": "#/components/schemas/BulkConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"bulk_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "BulkPrice"
},
"BulkTier": {
"properties": {
"maximum_units": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maximum Units",
"description": "Upper bound for this tier"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "BulkTier",
"description": "Configuration for a single bulk pricing tier"
},
"BulkTierWithProration": {
"properties": {
"tier_lower_bound": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tier Lower Bound",
"description": "The lower bound for this tier"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Cost per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "BulkTierWithProration",
"description": "Configuration for a single bulk pricing tier with proration"
},
"BulkWithFiltersConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/BulkWithFiltersTier"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Bulk tiers for rating based on total usage volume"
},
"filters": {
"items": {
"$ref": "#/components/schemas/FilterRule"
},
"type": "array",
"minItems": 1,
"title": "Filters",
"description": "Property filters to apply (all must match)"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"filters"
],
"title": "BulkWithFiltersConfig",
"description": "Bulk pricing with event filtering applies bulk pricing tiers based on total usage volume,\nbut only charges for events that match specified property filters.\n\nHow it works:\n1. **Tier Selection**: Uses the customer's total usage quantity to determine which bulk pricing tier applies\n2. **Event Filtering**: Only counts events where the specified property filters match (supports single or multiple filters)\n3. **Billing**: Charges the filtered quantity at the rate determined by the total usage tier\n\nExample:\n- Total usage: 150 events\n- Bulk tiers: 0-99 = $1.00, 100+ = $0.80\n- Filters: region=\"us-east-1\" AND environment=\"production\"\n- Filtered events: 75 events matching both filters\n- Result: 75 events \u00d7 $0.80 = $60.00 (rate determined by 150 total, but only 75 charged)\n\nThis allows customers to get bulk discounts based on their total volume while only paying\nfor usage in specific regions, environments, or other filtered categories."
},
"BulkWithFiltersPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_filters"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_filters_config": {
"$ref": "#/components/schemas/BulkWithFiltersConfig",
"description": "Configuration for bulk_with_filters pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"bulk_with_filters_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "BulkWithFiltersPrice"
},
"BulkWithFiltersTier": {
"properties": {
"tier_lower_bound": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tier Lower Bound",
"description": "The lower bound for this tier"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "BulkWithFiltersTier",
"description": "Configuration for a single bulk pricing tier"
},
"BulkWithProrationConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/BulkTierWithProration"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Bulk tiers for rating based on total usage volume"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "BulkWithProrationConfig",
"description": "Configuration for bulk pricing with proration"
},
"BulkWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_proration_config": {
"$ref": "#/components/schemas/BulkWithProrationConfig",
"description": "Configuration for bulk_with_proration pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"bulk_with_proration_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "BulkWithProrationPrice"
},
"CancelSubscriptionParams": {
"properties": {
"cancel_option": {
"type": "string",
"enum": [
"end_of_subscription_term",
"immediate",
"requested_date"
],
"title": "Cancel Option",
"description": "Determines the timing of subscription cancellation"
},
"cancellation_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cancellation Date",
"description": "The date that the cancellation should take effect. This parameter can only be passed if the `cancel_option` is `requested_date`."
},
"allow_invoice_credit_or_void": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Invoice Credit Or Void",
"description": "If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"cancel_option"
],
"title": "CancelSubscriptionParams"
},
"ChangedSubscriptionResources": {
"properties": {
"created_credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNote"
},
"type": "array",
"title": "Created Credit Notes",
"description": "The credit notes that were created as part of this operation."
},
"voided_credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNote"
},
"type": "array",
"title": "Voided Credit Notes",
"description": "The credit notes that were voided as part of this operation."
},
"created_invoices": {
"items": {
"$ref": "#/components/schemas/CreatedInvoice"
},
"type": "array",
"title": "Created Invoices",
"description": "The invoices that were created as part of this operation."
},
"voided_invoices": {
"items": {
"$ref": "#/components/schemas/Invoice"
},
"type": "array",
"title": "Voided Invoices",
"description": "The invoices that were voided as part of this operation."
}
},
"type": "object",
"required": [
"created_credit_notes",
"voided_credit_notes",
"created_invoices",
"voided_invoices"
],
"title": "ChangedSubscriptionResources"
},
"ConstraintViolationError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#400-constraint-violation"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
400
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "ConstraintViolationError"
},
"ConversionRateConfig": {
"oneOf": [
{
"$ref": "#/components/schemas/UnitConversionRateConfig"
},
{
"$ref": "#/components/schemas/TieredConversionRateConfig"
}
],
"discriminator": {
"propertyName": "conversion_rate_type",
"mapping": {
"tiered": "#/components/schemas/TieredConversionRateConfig",
"unit": "#/components/schemas/UnitConversionRateConfig"
}
}
},
"ConversionRateTier": {
"properties": {
"first_unit": {
"type": "number",
"title": "First Unit",
"description": "Exclusive tier starting value"
},
"last_unit": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Last Unit",
"description": "Inclusive tier ending value. If null, this is treated as the last tier"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit of overage"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_unit",
"unit_amount"
],
"title": "ConversionRateTier"
},
"ConversionRateTieredConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ConversionRateTier"
},
"type": "array",
"title": "Tiers",
"description": "Tiers for rating based on total usage quantities into the specified tier"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "ConversionRateTieredConfig"
},
"ConversionRateUnitConfig": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit of overage"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "ConversionRateUnitConfig"
},
"CostsRequestParams": {
"properties": {
"timeframe_start": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Costs returned are inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"timeframe_end": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Costs returned are exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"view_mode": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative costs since the start of the billing period, or incremental day-by-day costs. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency or custom pricing unit to use."
}
},
"additionalProperties": false,
"type": "object",
"title": "CostsRequestParams"
},
"Coupon": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "Also referred to as coupon_id in this documentation.",
"examples": [
"7iz2yanVjQoBZhyH"
]
},
"redemption_code": {
"type": "string",
"title": "Redemption Code",
"description": "This string can be used to redeem this coupon for a given subscription.",
"examples": [
"HALFOFF"
]
},
"discount": {
"$ref": "#/components/schemas/CouponDiscount"
},
"times_redeemed": {
"type": "integer",
"title": "Times Redeemed",
"description": "The number of times this coupon has been redeemed."
},
"duration_in_months": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Duration In Months",
"description": "This allows for a coupon's discount to apply for a limited time (determined in months); a `null` value here means \"unlimited time\".",
"examples": [
12
]
},
"max_redemptions": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Max Redemptions",
"description": "The maximum number of redemptions allowed for this coupon before it is exhausted; `null` here means \"unlimited\"."
},
"archived_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Archived At",
"description": "An archived coupon can no longer be redeemed. Active coupons will have a value of null for `archived_at`; this field will be non-null for archived coupons."
}
},
"type": "object",
"required": [
"id",
"redemption_code",
"discount",
"times_redeemed",
"duration_in_months",
"max_redemptions",
"archived_at"
],
"title": "Coupon",
"description": "A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users."
},
"CouponDiscount": {
"oneOf": [
{
"$ref": "#/components/schemas/PercentageDiscount"
},
{
"$ref": "#/components/schemas/AmountDiscount"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscount",
"percentage": "#/components/schemas/PercentageDiscount"
}
}
},
"CouponQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"show_archived": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Show Archived",
"description": "Show archived coupons as well (by default, this endpoint only returns active coupons)."
},
"redemption_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Redemption Code",
"description": "Filter to coupons matching this redemption code."
}
},
"additionalProperties": false,
"type": "object",
"title": "CouponQueryParams"
},
"CouponRedemption": {
"properties": {
"coupon_id": {
"type": "string",
"title": "Coupon Id"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date"
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
}
},
"type": "object",
"required": [
"coupon_id",
"start_date",
"end_date"
],
"title": "CouponRedemption"
},
"Coupons": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Coupon"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Coupons"
},
"CreateCreditNoteParams": {
"properties": {
"line_items": {
"items": {
"$ref": "#/components/schemas/CreditNoteLineItemParams"
},
"type": "array",
"minItems": 1,
"title": "Line Items"
},
"reason": {
"type": "string",
"enum": [
"duplicate",
"fraudulent",
"order_change",
"product_unsatisfactory"
],
"title": "Reason",
"description": "An optional reason for the credit note.",
"examples": [
"duplicate",
"fraudulent",
"order_change",
"product_unsatisfactory"
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo to attach to the credit note.",
"examples": [
"An optional memo for my credit note."
]
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "A date string to specify the global credit note service period start date in the customer's timezone. This will be applied to all line items that don't have their own individual service periods specified. If not provided, line items will use their original invoice line item service periods. This date is inclusive.",
"examples": [
"2023-09-22"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "A date string to specify the global credit note service period end date in the customer's timezone. This will be applied to all line items that don't have their own individual service periods specified. If not provided, line items will use their original invoice line item service periods. This date is inclusive.",
"examples": [
"2023-09-22"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"line_items",
"reason"
],
"title": "CreateCreditNoteParams"
},
"CreateCustomerAlertRequestParams": {
"properties": {
"thresholds": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Thresholds",
"description": "The thresholds that define the values at which the alert will be triggered."
},
"type": {
"type": "string",
"enum": [
"credit_balance_depleted",
"credit_balance_dropped",
"credit_balance_recovered"
],
"title": "Type",
"description": "The type of alert to create. This must be a valid alert type."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "The case sensitive currency or custom pricing unit to use for this alert. "
}
},
"additionalProperties": false,
"type": "object",
"required": [
"type",
"currency"
],
"title": "CreateCustomerAlertRequestParams"
},
"CreateInvoiceLineItemParams": {
"properties": {
"start_date": {
"type": "string",
"format": "date",
"title": "Start Date",
"description": "A date string to specify the line item's start date in the customer's timezone.",
"examples": [
"2023-09-22"
]
},
"end_date": {
"type": "string",
"format": "date",
"title": "End Date",
"description": "A date string to specify the line item's end date in the customer's timezone.",
"examples": [
"2023-09-22"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"description": "The number of units on the line item",
"examples": [
1
]
},
"invoice_id": {
"type": "string",
"title": "Invoice Id",
"description": "The id of the Invoice to add this line item.",
"examples": [
"4khy3nwzktxv7"
]
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name to use for the line item. If `item_id` is not provided, Orb will search for an item with this name. If found, that item will be associated with the line item. If not found, a new item will be created with this name. If `item_id` is provided, this name will be used for the line item, but the item association will be based on `item_id`. At least one of `name` or `item_id` must be provided.",
"examples": [
"Item Name"
]
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The total amount in the invoice's currency to add to the line item.",
"examples": [
"12.00"
]
},
"item_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Item Id",
"description": "The id of the item to associate with this line item. If provided without `name`, the item's name will be used for the price/line item. If provided with `name`, the item will be associated but `name` will be used for the line item. At least one of `name` or `item_id` must be provided.",
"examples": [
"4khy3nwzktxv7"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"start_date",
"end_date",
"quantity",
"invoice_id",
"amount"
],
"title": "CreateInvoiceLineItemParams"
},
"CreateOneOffInvoiceParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The id of the `Customer` to create this invoice for. One of `customer_id` and `external_customer_id` are required.",
"examples": [
"4khy3nwzktxv7"
]
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The `external_customer_id` of the `Customer` to create this invoice for. One of `customer_id` and `external_customer_id` are required.",
"examples": [
"external-customer-id"
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string. Must be the same as the customer's currency if it is set.",
"examples": [
"USD"
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo to attach to the invoice. If no memo is provided, we will attach the default memo",
"examples": [
"An optional memo for my invoice."
]
},
"will_auto_issue": {
"type": "boolean",
"title": "Will Auto Issue",
"description": "When true, this invoice will be submitted for issuance upon creation. When false, the resulting invoice will require manual review to issue. Defaulted to false.",
"default": false,
"examples": [
false
]
},
"invoice_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
}
],
"title": "Invoice Date",
"description": "Optional invoice date to set. Must be in the past, if not set, `invoice_date` is set to the current time in the customer's timezone.",
"examples": [
"2023-09-22"
]
},
"net_terms": {
"oneOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the due date of the invoice. Due date is calculated based on the invoice or issuance date, depending on the account's configured due date calculation method. A value of '0' here represents that the invoice is due on issue, whereas a value of '30' represents that the customer has 30 days to pay the invoice. Do not set this field if you want to set a custom due date.",
"examples": [
0
]
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "An optional custom due date for the invoice. If not set, the due date will be calculated based on the `net_terms` value.",
"examples": [
"2023-09-22"
]
},
"line_items": {
"items": {
"$ref": "#/components/schemas/InvoiceLineItemParams"
},
"type": "array",
"minItems": 1,
"title": "Line Items"
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"description": "An optional discount to attach to the invoice."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether this invoice will automatically attempt to charge a saved payment method, if any. If not specified, the invoice inherits the customer's auto_collection setting."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"currency",
"invoice_date",
"line_items"
],
"title": "CreateOneOffInvoiceParams"
},
"CreateSubscriptionAlertRequestParams": {
"properties": {
"thresholds": {
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array",
"title": "Thresholds",
"description": "The thresholds that define the values at which the alert will be triggered."
},
"type": {
"type": "string",
"enum": [
"usage_exceeded",
"cost_exceeded"
],
"title": "Type",
"description": "The type of alert to create. This must be a valid alert type."
},
"metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Metric Id",
"description": "The metric to track usage for."
},
"grouping_keys": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Grouping Keys",
"description": "The property keys to group cost alerts by. Only applicable for cost_exceeded alerts."
},
"pricing_unit_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Pricing Unit Id",
"description": "The pricing unit to use for grouped cost alerts. Required when grouping_keys is set."
},
"price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Price Filters",
"description": "Filters to scope which prices are included in grouped cost alert evaluation. Supports filtering by price_id, item_id, or price_type with includes/excludes operators. Only applicable when grouping_keys is set."
},
"threshold_overrides": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ThresholdOverrideParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Threshold Overrides",
"description": "Per-group threshold overrides. Each override maps a specific combination of grouping_keys values to a list of thresholds that fully replaces the default thresholds for that group. An empty thresholds list silences the group. Groups without an override use the default thresholds. Only applicable when grouping_keys is set."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"thresholds",
"type"
],
"title": "CreateSubscriptionAlertRequestParams"
},
"CreatedInvoice": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "If the invoice has a status of `void`, this gives a timestamp when the invoice was voided."
},
"paid_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Paid At",
"description": "If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid."
},
"issued_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issued At",
"description": "If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)"
},
"scheduled_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Scheduled Issue At",
"description": "If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued."
},
"auto_collection": {
"$ref": "#/components/schemas/AutoCollection"
},
"issue_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issue Failed At",
"description": "If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)"
},
"sync_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Sync Failed At",
"description": "If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing."
},
"payment_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Failed At",
"description": "If payment was attempted on this invoice but failed, this will be the time of the most recent attempt."
},
"payment_started_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Started At",
"description": "If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more."
},
"amount_due": {
"type": "string",
"title": "Amount Due",
"description": "This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.",
"examples": [
"8.00"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or `credits`",
"examples": [
"USD"
]
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "When the invoice payment is due. The due date is null if the invoice is not yet finalized.",
"examples": [
"2022-05-30T07:00:00+00:00"
]
},
"id": {
"type": "string",
"title": "Id"
},
"invoice_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Pdf",
"description": "The link to download the PDF representation of the `Invoice`.",
"examples": [
"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
]
},
"invoice_number": {
"type": "string",
"title": "Invoice Number",
"description": "Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.",
"examples": [
"JYEFHK-00001"
]
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
]
},
"total": {
"type": "string",
"title": "Total",
"description": "The total after any minimums and discounts have been applied.",
"examples": [
"8.00"
]
},
"customer_balance_transactions": {
"items": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
},
"type": "array",
"title": "Customer Balance Transactions"
},
"status": {
"type": "string",
"enum": [
"issued",
"paid",
"synced",
"void",
"draft"
],
"title": "Status"
},
"invoice_source": {
"type": "string",
"enum": [
"subscription",
"partial",
"one_off"
],
"title": "Invoice Source"
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"hosted_invoice_url": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hosted Invoice Url",
"description": "A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date \u2014 whichever is later."
},
"will_auto_issue": {
"type": "boolean",
"title": "Will Auto Issue",
"description": "This is true if the invoice will be automatically issued in the future, and false otherwise."
},
"eligible_to_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Eligible To Issue At",
"description": "If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time."
},
"customer_tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "Free-form text which is available on the invoice PDF and the Orb invoice portal."
},
"credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNoteSummary"
},
"type": "array",
"title": "Credit Notes",
"description": "A list of credit notes associated with the invoice"
},
"payment_attempts": {
"items": {
"$ref": "#/components/schemas/PaymentAttempt"
},
"type": "array",
"title": "Payment Attempts",
"description": "A list of payment attempts associated with the invoice"
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/DEPRECATED_InvoiceLevelDiscount"
},
{
"type": "null"
}
],
"description": "This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the first discount in the list will be returned. If the list is empty, `None` will be returned.",
"deprecated": true
},
"discounts": {
"items": {
"$ref": "#/components/schemas/InvoiceLevelDiscount"
},
"type": "array",
"title": "Discounts"
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
]
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount"
},
"line_items": {
"items": {
"$ref": "#/components/schemas/InvoiceLineItem"
},
"type": "array",
"title": "Line Items",
"description": "The breakdown of prices in this invoice."
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The total before any discounts and minimums are applied.",
"examples": [
"8.00"
]
},
"invoice_date": {
"type": "string",
"format": "date-time",
"title": "Invoice Date",
"description": "The scheduled date of the invoice",
"examples": [
"2022-05-01T07:00:00+00:00"
]
},
"is_payable_now": {
"type": "boolean",
"title": "Is Payable Now",
"description": "True if the invoice has only in-advance fixed fees and is payable now"
}
},
"type": "object",
"required": [
"metadata",
"voided_at",
"paid_at",
"issued_at",
"scheduled_issue_at",
"auto_collection",
"issue_failed_at",
"sync_failed_at",
"payment_failed_at",
"payment_started_at",
"amount_due",
"created_at",
"currency",
"customer",
"due_date",
"id",
"invoice_pdf",
"invoice_number",
"subscription",
"total",
"customer_balance_transactions",
"status",
"invoice_source",
"shipping_address",
"billing_address",
"hosted_invoice_url",
"will_auto_issue",
"eligible_to_issue_at",
"customer_tax_id",
"memo",
"credit_notes",
"payment_attempts",
"discount",
"discounts",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount",
"line_items",
"subtotal",
"invoice_date",
"is_payable_now"
],
"title": "CreatedInvoice"
},
"CreditBlock": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"balance": {
"type": "number",
"title": "Balance"
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date"
},
"expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expiry Date"
},
"per_unit_cost_basis": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Per Unit Cost Basis"
},
"status": {
"type": "string",
"enum": [
"active",
"pending_payment"
],
"title": "Status"
},
"maximum_initial_balance": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maximum Initial Balance"
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters"
}
},
"type": "object",
"required": [
"metadata",
"id",
"balance",
"effective_date",
"expiry_date",
"per_unit_cost_basis",
"status",
"maximum_initial_balance",
"filters"
],
"title": "CreditBlock",
"description": "The Credit Block resource models prepaid credits within Orb."
},
"CreditBlockExpiryLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"credit_block_expiry"
],
"title": "Entry Type"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type"
],
"title": "CreditBlockExpiryLedgerEntry"
},
"CreditBlockInvoicesResponse": {
"properties": {
"block": {
"$ref": "#/components/schemas/CreditBlock"
},
"invoices": {
"items": {
"$ref": "#/components/schemas/InvoiceMinified"
},
"type": "array",
"title": "Invoices"
}
},
"type": "object",
"required": [
"block",
"invoices"
],
"title": "CreditBlockInvoicesResponse"
},
"CreditLedgerEntries": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CreditLedgerEntry"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "CreditLedgerEntries"
},
"CreditLedgerEntry": {
"oneOf": [
{
"$ref": "#/components/schemas/IncrementLedgerEntry"
},
{
"$ref": "#/components/schemas/DecrementLedgerEntry"
},
{
"$ref": "#/components/schemas/ExpirationChangeLedgerEntry"
},
{
"$ref": "#/components/schemas/CreditBlockExpiryLedgerEntry"
},
{
"$ref": "#/components/schemas/VoidLedgerEntry"
},
{
"$ref": "#/components/schemas/VoidInitiatedLedgerEntry"
},
{
"$ref": "#/components/schemas/AmendmentLedgerEntry"
}
],
"description": "The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb.",
"discriminator": {
"propertyName": "entry_type",
"mapping": {
"amendment": "#/components/schemas/AmendmentLedgerEntry",
"credit_block_expiry": "#/components/schemas/CreditBlockExpiryLedgerEntry",
"decrement": "#/components/schemas/DecrementLedgerEntry",
"expiration_change": "#/components/schemas/ExpirationChangeLedgerEntry",
"increment": "#/components/schemas/IncrementLedgerEntry",
"void": "#/components/schemas/VoidLedgerEntry",
"void_initiated": "#/components/schemas/VoidInitiatedLedgerEntry"
}
}
},
"CreditNote": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The Orb id of this credit note."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb."
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "The time at which the credit note was voided in Orb, if applicable."
},
"credit_note_number": {
"type": "string",
"title": "Credit Note Number",
"description": "The unique identifier for credit notes."
},
"invoice_id": {
"type": "string",
"title": "Invoice Id",
"description": "The id of the invoice resource that this credit note is applied to."
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo supplied on the credit note."
},
"reason": {
"oneOf": [
{
"type": "string",
"enum": [
"Duplicate",
"Fraudulent",
"Order change",
"Product unsatisfactory"
]
},
{
"type": "null"
}
],
"title": "Reason"
},
"type": {
"type": "string",
"enum": [
"refund",
"adjustment"
],
"title": "Type"
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The total prior to any creditable invoice-level discounts or minimums."
},
"total": {
"type": "string",
"title": "Total",
"description": "The total including creditable invoice-level discounts or minimums, and tax."
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"credit_note_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Credit Note Pdf",
"description": "A URL to a PDF of the credit note."
},
"minimum_amount_refunded": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount Refunded",
"description": "Any credited amount from the applied minimum on the invoice."
},
"discounts": {
"items": {
"$ref": "#/components/schemas/CreditNoteDiscount"
},
"type": "array",
"title": "Discounts",
"description": "Any discounts applied on the original invoice.",
"default": []
},
"maximum_amount_adjustment": {
"oneOf": [
{
"$ref": "#/components/schemas/CreditNoteDiscount"
},
{
"type": "null"
}
],
"description": "The maximum amount applied on the original invoice"
},
"line_items": {
"items": {
"$ref": "#/components/schemas/CreditNoteLineItem"
},
"type": "array",
"title": "Line Items",
"description": "All of the line items associated with this credit note."
}
},
"type": "object",
"required": [
"id",
"created_at",
"voided_at",
"credit_note_number",
"invoice_id",
"memo",
"reason",
"type",
"subtotal",
"total",
"customer",
"credit_note_pdf",
"minimum_amount_refunded",
"maximum_amount_adjustment",
"line_items"
],
"title": "CreditNote",
"description": "The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a\nparticular invoice."
},
"CreditNoteDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage"
],
"title": "Discount Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount"
},
"amount_applied": {
"type": "string",
"title": "Amount Applied"
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"applies_to_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/CreditNoteDiscountAppliesToPrice"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applies To Prices"
}
},
"type": "object",
"required": [
"discount_type",
"percentage_discount",
"amount_applied"
],
"title": "CreditNoteDiscount"
},
"CreditNoteDiscountAppliesToPrice": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "CreditNoteDiscountAppliesToPrice"
},
"CreditNoteLineItem": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The Orb id of this resource."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the corresponding invoice line item."
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The amount of the line item, excluding any line item minimums and discounts."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount of the line item, including any line item minimums and discounts."
},
"quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity",
"description": "An optional quantity credited."
},
"discounts": {
"items": {
"$ref": "#/components/schemas/CreditNoteLineItemDiscount"
},
"type": "array",
"title": "Discounts",
"description": "Any line item discounts from the invoice's line item.",
"default": []
},
"tax_amounts": {
"items": {
"$ref": "#/components/schemas/TaxAmount"
},
"type": "array",
"title": "Tax Amounts",
"description": "Any tax amounts applied onto the line item."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item associated with this line item."
},
"start_time_inclusive": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Time Inclusive",
"description": "The start time of the service period for this credit note line item."
},
"end_time_exclusive": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Time Exclusive",
"description": "The end time of the service period for this credit note line item."
}
},
"type": "object",
"required": [
"id",
"name",
"subtotal",
"amount",
"quantity",
"tax_amounts",
"item_id"
],
"title": "CreditNoteLineItem"
},
"CreditNoteLineItemDiscount": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"discount_type": {
"type": "string",
"enum": [
"percentage",
"amount"
],
"title": "Discount Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount"
},
"amount_discount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount Discount"
},
"amount_applied": {
"type": "string",
"title": "Amount Applied"
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids"
}
},
"type": "object",
"required": [
"id",
"discount_type",
"percentage_discount",
"amount_applied",
"applies_to_price_ids"
],
"title": "CreditNoteLineItemDiscount"
},
"CreditNoteLineItemParams": {
"properties": {
"invoice_line_item_id": {
"type": "string",
"title": "Invoice Line Item Id",
"description": "The ID of the line item to credit.",
"examples": [
"4khy3nwzktxv7"
]
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The total amount in the invoice's currency to credit this line item."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "A date string to specify this line item's credit note service period start date in the customer's timezone. If provided, this will be used for this specific line item. If not provided, will use the global start_date if available, otherwise defaults to the original invoice line item's start date. This date is inclusive.",
"examples": [
"2023-09-22"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "A date string to specify this line item's credit note service period end date in the customer's timezone. If provided, this will be used for this specific line item. If not provided, will use the global end_date if available, otherwise defaults to the original invoice line item's end date. This date is inclusive.",
"examples": [
"2023-09-22"
]
}
},
"type": "object",
"required": [
"invoice_line_item_id",
"amount"
],
"title": "CreditNoteLineItemParams"
},
"CreditNoteSummary": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"credit_note_number": {
"type": "string",
"title": "Credit Note Number"
},
"reason": {
"type": "string",
"title": "Reason"
},
"total": {
"type": "string",
"title": "Total"
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "If the credit note has a status of `void`, this gives a timestamp when the credit note was voided.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"type": {
"type": "string",
"title": "Type"
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo supplied on the credit note."
}
},
"type": "object",
"required": [
"id",
"credit_note_number",
"reason",
"total",
"voided_at",
"type",
"memo"
],
"title": "CreditNoteSummary"
},
"CreditNoteTiny": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The id of the Credit note"
}
},
"type": "object",
"required": [
"id"
],
"title": "CreditNoteTiny"
},
"CreditNotes": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CreditNote"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "CreditNotes"
},
"CumulativeGroupedAllocationConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The event property used to group usage before applying allocations"
},
"group_allocation": {
"type": "string",
"title": "Group Allocation",
"description": "The allocation per individual group"
},
"cumulative_allocation": {
"type": "string",
"title": "Cumulative Allocation",
"description": "The overall allocation across all groups"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "The amount to charge for each unit outside of the allocation"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"group_allocation",
"cumulative_allocation",
"unit_amount"
],
"title": "CumulativeGroupedAllocationConfig",
"description": "Configuration for cumulative grouped allocation pricing.\n\nThis rating function groups usage by a grouping key and applies both per-group\nand cumulative allocations. For each group (ordered by group value), it calculates\nthe larger of the group overage and the incremental cumulative overage."
},
"CumulativeGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_allocation_config": {
"$ref": "#/components/schemas/CumulativeGroupedAllocationConfig",
"description": "Configuration for cumulative_grouped_allocation pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"cumulative_grouped_allocation_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "CumulativeGroupedAllocationPrice"
},
"CumulativeGroupedBulkConfig": {
"properties": {
"group": {
"type": "string",
"title": "Group"
},
"dimension_values": {
"items": {
"$ref": "#/components/schemas/CumulativeGroupedBulkDimensionValue"
},
"type": "array",
"minItems": 1,
"title": "Dimension Values",
"description": "Each tier lower bound must have the same group of values."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"group",
"dimension_values"
],
"title": "CumulativeGroupedBulkConfig",
"description": "Configuration for cumulative grouped bulk pricing"
},
"CumulativeGroupedBulkDimensionValue": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound",
"description": "Tier lower bound"
},
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "Grouping key value"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Unit amount for this combination"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"grouping_key",
"unit_amount"
],
"title": "CumulativeGroupedBulkDimensionValue",
"description": "Configuration for a dimension value entry"
},
"CumulativeGroupedBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_bulk_config": {
"$ref": "#/components/schemas/CumulativeGroupedBulkConfig",
"description": "Configuration for cumulative_grouped_bulk pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"cumulative_grouped_bulk_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "CumulativeGroupedBulkPrice"
},
"CustomExpiration": {
"properties": {
"duration": {
"type": "integer",
"title": "Duration"
},
"duration_unit": {
"type": "string",
"enum": [
"day",
"month"
],
"title": "Duration Unit"
}
},
"type": "object",
"required": [
"duration",
"duration_unit"
],
"title": "CustomExpiration"
},
"Customer": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system."
},
"name": {
"type": "string",
"title": "Name",
"description": "The full name of the customer"
},
"email": {
"type": "string",
"title": "Email",
"description": "A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts."
},
"timezone": {
"type": "string",
"title": "Timezone",
"description": "A timezone identifier from the IANA timezone database, such as \"America/Los_Angeles\". This \"defaults to your account's timezone if not set. This cannot be changed after customer creation."
},
"payment_provider_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Provider Id",
"description": "The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb."
},
"payment_provider": {
"oneOf": [
{
"type": "string",
"enum": [
"quickbooks",
"bill.com",
"stripe_charge",
"stripe_invoice",
"netsuite"
]
},
{
"type": "null"
}
],
"title": "Payment Provider",
"description": "This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"balance": {
"type": "string",
"title": "Balance",
"description": "The customer's current balance in their currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency"
},
"tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"auto_collection": {
"type": "boolean",
"title": "Auto Collection"
},
"exempt_from_automated_tax": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Exempt From Automated Tax"
},
"email_delivery": {
"type": "boolean",
"title": "Email Delivery"
},
"auto_issuance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Issuance",
"description": "Whether invoices for this customer should be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If null, inherits the account-level setting."
},
"additional_emails": {
"items": {
"type": "string"
},
"type": "array",
"title": "Additional Emails"
},
"portal_url": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Portal Url",
"description": "Deprecated. Returns the URL of the most recent non-expired portal link, or null. When the account has opted into customer portal sessions, this field always returns null. Use POST /v1/customers/{id}/portal_sessions to mint short-lived portal session URLs."
},
"accounting_sync_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/AccountingSyncConfiguration"
},
{
"type": "null"
}
]
},
"reporting_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/ReportingConfiguration"
},
{
"type": "null"
}
]
},
"payment_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/PaymentConfiguration"
},
{
"type": "null"
}
],
"description": "Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe."
},
"hierarchy": {
"$ref": "#/components/schemas/CustomerHierarchy",
"description": "The hierarchical relationships for this customer."
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether automatic tax calculation is enabled for this customer. This field is nullable for backwards compatibility but will always return a boolean value."
}
},
"type": "object",
"required": [
"metadata",
"id",
"external_customer_id",
"name",
"email",
"timezone",
"payment_provider_id",
"payment_provider",
"created_at",
"shipping_address",
"billing_address",
"balance",
"currency",
"tax_id",
"auto_collection",
"exempt_from_automated_tax",
"email_delivery",
"auto_issuance",
"additional_emails",
"portal_url",
"hierarchy"
],
"title": "Customer",
"description": "A customer is a buyer of your products, and the other party to the billing relationship.\n\nIn Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these\nmatch existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an\n`external_customer_id` with your own identifier. See\n[Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these\naliases work in Orb.\n\nIn addition to having an identifier in your system, a customer may exist in a payment provider solution like\nStripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.\n\nA customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which\ndefaults to your account's timezone. See [Timezone localization](/essentials/timezones) for\ninformation on what this timezone parameter influences within Orb."
},
"CustomerBalanceTransaction": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "A unique id for this transaction.",
"examples": [
"cgZa3SXcsPTVyC4Y"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of this transaction.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"starting_balance": {
"type": "string",
"title": "Starting Balance",
"description": "The original value of the customer's balance prior to the transaction, in the customer's currency.",
"examples": [
"33.00"
]
},
"ending_balance": {
"type": "string",
"title": "Ending Balance",
"description": "The new value of the customer's balance prior to the transaction, in the customer's currency.",
"examples": [
"22.00"
]
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value of the amount changed in the transaction.",
"examples": [
"11.00"
]
},
"action": {
"type": "string",
"enum": [
"applied_to_invoice",
"manual_adjustment",
"prorated_refund",
"revert_prorated_refund",
"return_from_voiding",
"credit_note_applied",
"credit_note_voided",
"overpayment_refund",
"external_payment",
"small_invoice_carryover"
],
"title": "Action"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional description provided for manual customer balance adjustments.",
"examples": [
"An optional description"
]
},
"invoice": {
"oneOf": [
{
"$ref": "#/components/schemas/InvoiceTiny"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"increment",
"decrement"
],
"title": "Type"
},
"credit_note": {
"oneOf": [
{
"$ref": "#/components/schemas/CreditNoteTiny"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"created_at",
"starting_balance",
"ending_balance",
"amount",
"action",
"description",
"invoice",
"type",
"credit_note"
],
"title": "CustomerBalanceTransaction"
},
"CustomerBalanceTransactions": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "CustomerBalanceTransactions"
},
"CustomerCosts": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AggregatedCost"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "CustomerCosts"
},
"CustomerCreditBalance": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"balance": {
"type": "number",
"title": "Balance"
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date"
},
"expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expiry Date"
},
"per_unit_cost_basis": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Per Unit Cost Basis"
},
"status": {
"type": "string",
"enum": [
"active",
"pending_payment"
],
"title": "Status"
},
"maximum_initial_balance": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Maximum Initial Balance"
},
"filters": {
"items": {
"$ref": "#/components/schemas/BlockPriceFilter"
},
"type": "array",
"title": "Filters"
}
},
"type": "object",
"required": [
"metadata",
"id",
"balance",
"effective_date",
"expiry_date",
"per_unit_cost_basis",
"status",
"maximum_initial_balance",
"filters"
],
"title": "CustomerCreditBalance"
},
"CustomerCreditBalances": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/CustomerCreditBalance"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "CustomerCreditBalances"
},
"CustomerHierarchy": {
"properties": {
"parent": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerMinified"
},
{
"type": "null"
}
]
},
"children": {
"items": {
"$ref": "#/components/schemas/CustomerMinified"
},
"type": "array",
"title": "Children"
}
},
"type": "object",
"required": [
"parent",
"children"
],
"title": "CustomerHierarchy"
},
"CustomerHierarchyConfig": {
"properties": {
"parent_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Parent Customer Id",
"description": "The ID of the parent customer in the hierarchy. The desired parent customer must not be a child of another customer."
},
"child_customer_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Child Customer Ids",
"description": "A list of child customer IDs to add to the hierarchy. The desired child customers must not already be part of another hierarchy."
}
},
"type": "object",
"title": "CustomerHierarchyConfig"
},
"CustomerMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
}
},
"type": "object",
"required": [
"id",
"external_customer_id"
],
"title": "CustomerMinified"
},
"CustomerTaxId": {
"properties": {
"country": {
"type": "string",
"enum": [
"AD",
"AE",
"AL",
"AM",
"AO",
"AR",
"AT",
"AU",
"AW",
"AZ",
"BA",
"BB",
"BD",
"BE",
"BF",
"BG",
"BH",
"BJ",
"BO",
"BR",
"BS",
"BY",
"CA",
"CD",
"CH",
"CL",
"CM",
"CN",
"CO",
"CR",
"CV",
"CY",
"CZ",
"DE",
"DK",
"DO",
"EC",
"EE",
"EG",
"ES",
"ET",
"EU",
"FI",
"FO",
"FR",
"GB",
"GE",
"GI",
"GN",
"GR",
"HK",
"HR",
"HU",
"ID",
"IE",
"IL",
"IN",
"IS",
"IT",
"JP",
"KE",
"KG",
"KH",
"KR",
"KZ",
"LA",
"LI",
"LK",
"LT",
"LU",
"LV",
"MA",
"MD",
"ME",
"MK",
"MR",
"MT",
"MX",
"MY",
"NG",
"NL",
"NO",
"NP",
"NZ",
"OM",
"PE",
"PH",
"PL",
"PT",
"PY",
"RO",
"RS",
"RU",
"SA",
"SE",
"SG",
"SI",
"SK",
"SN",
"SR",
"SV",
"TH",
"TJ",
"TR",
"TW",
"TZ",
"UA",
"UG",
"US",
"UY",
"UZ",
"VE",
"VN",
"ZA",
"ZM",
"ZW"
],
"title": "Country"
},
"type": {
"type": "string",
"enum": [
"ad_nrt",
"ae_trn",
"al_tin",
"am_tin",
"ao_tin",
"ar_cuit",
"eu_vat",
"au_abn",
"au_arn",
"aw_tin",
"az_tin",
"ba_tin",
"bb_tin",
"bd_bin",
"bf_ifu",
"bg_uic",
"bh_vat",
"bj_ifu",
"bo_tin",
"br_cnpj",
"br_cpf",
"bs_tin",
"by_tin",
"ca_bn",
"ca_gst_hst",
"ca_pst_bc",
"ca_pst_mb",
"ca_pst_sk",
"ca_qst",
"cd_nif",
"ch_uid",
"ch_vat",
"cl_tin",
"cm_niu",
"cn_tin",
"co_nit",
"cr_tin",
"cv_nif",
"de_stn",
"do_rcn",
"ec_ruc",
"eg_tin",
"es_cif",
"et_tin",
"eu_oss_vat",
"fo_vat",
"gb_vat",
"ge_vat",
"gi_tin",
"gn_nif",
"hk_br",
"hr_oib",
"hu_tin",
"id_npwp",
"il_vat",
"in_gst",
"is_vat",
"it_cf",
"jp_cn",
"jp_rn",
"jp_trn",
"ke_pin",
"kg_tin",
"kh_tin",
"kr_brn",
"kz_bin",
"la_tin",
"li_uid",
"li_vat",
"lk_vat",
"ma_vat",
"md_vat",
"me_pib",
"mk_vat",
"mr_nif",
"mx_rfc",
"my_frp",
"my_itn",
"my_sst",
"ng_tin",
"no_vat",
"no_voec",
"np_pan",
"nz_gst",
"om_vat",
"pe_ruc",
"ph_tin",
"pl_nip",
"py_ruc",
"ro_tin",
"rs_pib",
"ru_inn",
"ru_kpp",
"sa_vat",
"sg_gst",
"sg_uen",
"si_tin",
"sn_ninea",
"sr_fin",
"sv_nit",
"th_vat",
"tj_tin",
"tr_tin",
"tw_vat",
"tz_vat",
"ua_vat",
"ug_tin",
"us_ein",
"uy_ruc",
"uz_tin",
"uz_vat",
"ve_rif",
"vn_tin",
"za_vat",
"zm_tin",
"zw_tin"
],
"title": "Type"
},
"value": {
"type": "string",
"title": "Value"
}
},
"type": "object",
"required": [
"country",
"type",
"value"
],
"title": "CustomerTaxId",
"description": "Tax IDs are commonly required to be displayed on customer invoices, which are added to the headers of invoices.\n\n\n### Supported Tax ID Countries and Types\n\n\n| Country | Type | Description |\n|---------|------|-------------|\n| Albania | `al_tin` | Albania Tax Identification Number |\n| Andorra | `ad_nrt` | Andorran NRT Number |\n| Angola | `ao_tin` | Angola Tax Identification Number |\n| Argentina | `ar_cuit` | Argentinian Tax ID Number |\n| Armenia | `am_tin` | Armenia Tax Identification Number |\n| Aruba | `aw_tin` | Aruba Tax Identification Number |\n| Australia | `au_abn` | Australian Business Number (AU ABN) |\n| Australia | `au_arn` | Australian Taxation Office Reference Number |\n| Austria | `eu_vat` | European VAT Number |\n| Azerbaijan | `az_tin` | Azerbaijan Tax Identification Number |\n| Bahamas | `bs_tin` | Bahamas Tax Identification Number |\n| Bahrain | `bh_vat` | Bahraini VAT Number |\n| Bangladesh | `bd_bin` | Bangladesh Business Identification Number |\n| Barbados | `bb_tin` | Barbados Tax Identification Number |\n| Belarus | `by_tin` | Belarus TIN Number |\n| Belgium | `eu_vat` | European VAT Number |\n| Benin | `bj_ifu` | Benin Tax Identification Number (Identifiant Fiscal Unique) |\n| Bolivia | `bo_tin` | Bolivian Tax ID |\n| Bosnia and Herzegovina | `ba_tin` | Bosnia and Herzegovina Tax Identification Number |\n| Brazil | `br_cnpj` | Brazilian CNPJ Number |\n| Brazil | `br_cpf` | Brazilian CPF Number |\n| Bulgaria | `bg_uic` | Bulgaria Unified Identification Code |\n| Bulgaria | `eu_vat` | European VAT Number |\n| Burkina Faso | `bf_ifu` | Burkina Faso Tax Identification Number (Num\u00e9ro d'Identifiant Fiscal Unique) |\n| Cambodia | `kh_tin` | Cambodia Tax Identification Number |\n| Cameroon | `cm_niu` | Cameroon Tax Identification Number (Num\u00e9ro d'Identifiant fiscal Unique) |\n| Canada | `ca_bn` | Canadian BN |\n| Canada | `ca_gst_hst` | Canadian GST/HST Number |\n| Canada | `ca_pst_bc` | Canadian PST Number (British Columbia) |\n| Canada | `ca_pst_mb` | Canadian PST Number (Manitoba) |\n| Canada | `ca_pst_sk` | Canadian PST Number (Saskatchewan) |\n| Canada | `ca_qst` | Canadian QST Number (Qu\u00e9bec) |\n| Cape Verde | `cv_nif` | Cape Verde Tax Identification Number (N\u00famero de Identifica\u00e7\u00e3o Fiscal) |\n| Chile | `cl_tin` | Chilean TIN |\n| China | `cn_tin` | Chinese Tax ID |\n| Colombia | `co_nit` | Colombian NIT Number |\n| Congo-Kinshasa | `cd_nif` | Congo (DR) Tax Identification Number (N\u00famero de Identifica\u00e7\u00e3o Fiscal) |\n| Costa Rica | `cr_tin` | Costa Rican Tax ID |\n| Croatia | `eu_vat` | European VAT Number |\n| Croatia | `hr_oib` | Croatian Personal Identification Number (OIB) |\n| Cyprus | `eu_vat` | European VAT Number |\n| Czech Republic | `eu_vat` | European VAT Number |\n| Denmark | `eu_vat` | European VAT Number |\n| Dominican Republic | `do_rcn` | Dominican RCN Number |\n| Ecuador | `ec_ruc` | Ecuadorian RUC Number |\n| Egypt | `eg_tin` | Egyptian Tax Identification Number |\n| El Salvador | `sv_nit` | El Salvadorian NIT Number |\n| Estonia | `eu_vat` | European VAT Number |\n| Ethiopia | `et_tin` | Ethiopia Tax Identification Number |\n| European Union | `eu_oss_vat` | European One Stop Shop VAT Number for non-Union scheme |\n| Faroe Islands | `fo_vat` | Faroe Islands VAT Number |\n| Finland | `eu_vat` | European VAT Number |\n| France | `eu_vat` | European VAT Number |\n| Georgia | `ge_vat` | Georgian VAT |\n| Germany | `de_stn` | German Tax Number (Steuernummer) |\n| Germany | `eu_vat` | European VAT Number |\n| Gibraltar | `gi_tin` | Gibraltar Tax Identification Number |\n| Greece | `eu_vat` | European VAT Number |\n| Guinea | `gn_nif` | Guinea Tax Identification Number (N\u00famero de Identifica\u00e7\u00e3o Fiscal) |\n| Hong Kong | `hk_br` | Hong Kong BR Number |\n| Hungary | `eu_vat` | European VAT Number |\n| Hungary | `hu_tin` | Hungary Tax Number (ad\u00f3sz\u00e1m) |\n| Iceland | `is_vat` | Icelandic VAT |\n| India | `in_gst` | Indian GST Number |\n| Indonesia | `id_npwp` | Indonesian NPWP Number |\n| Ireland | `eu_vat` | European VAT Number |\n| Israel | `il_vat` | Israel VAT |\n| Italy | `eu_vat` | European VAT Number |\n| Italy | `it_cf` | Italian Codice Fiscale Number |\n| Japan | `jp_cn` | Japanese Corporate Number (*H\u014djin Bang\u014d*) |\n| Japan | `jp_rn` | Japanese Registered Foreign Businesses' Registration Number (*T\u014droku Kokugai Jigy\u014dsha no T\u014droku Bang\u014d*) |\n| Japan | `jp_trn` | Japanese Tax Registration Number (*T\u014droku Bang\u014d*) |\n| Kazakhstan | `kz_bin` | Kazakhstani Business Identification Number |\n| Kenya | `ke_pin` | Kenya Revenue Authority Personal Identification Number |\n| Kyrgyzstan | `kg_tin` | Kyrgyzstan Tax Identification Number |\n| Laos | `la_tin` | Laos Tax Identification Number |\n| Latvia | `eu_vat` | European VAT Number |\n| Liechtenstein | `li_uid` | Liechtensteinian UID Number |\n| Liechtenstein | `li_vat` | Liechtenstein VAT Number |\n| Lithuania | `eu_vat` | European VAT Number |\n| Luxembourg | `eu_vat` | European VAT Number |\n| Malaysia | `my_frp` | Malaysian FRP Number |\n| Malaysia | `my_itn` | Malaysian ITN |\n| Malaysia | `my_sst` | Malaysian SST Number |\n| Malta | `eu_vat` | European VAT Number |\n| Mauritania | `mr_nif` | Mauritania Tax Identification Number (N\u00famero de Identifica\u00e7\u00e3o Fiscal) |\n| Mexico | `mx_rfc` | Mexican RFC Number |\n| Moldova | `md_vat` | Moldova VAT Number |\n| Montenegro | `me_pib` | Montenegro PIB Number |\n| Morocco | `ma_vat` | Morocco VAT Number |\n| Nepal | `np_pan` | Nepal PAN Number |\n| Netherlands | `eu_vat` | European VAT Number |\n| New Zealand | `nz_gst` | New Zealand GST Number |\n| Nigeria | `ng_tin` | Nigerian Tax Identification Number |\n| North Macedonia | `mk_vat` | North Macedonia VAT Number |\n| Northern Ireland | `eu_vat` | Northern Ireland VAT Number |\n| Norway | `no_vat` | Norwegian VAT Number |\n| Norway | `no_voec` | Norwegian VAT on e-commerce Number |\n| Oman | `om_vat` | Omani VAT Number |\n| Paraguay | `py_ruc` | Paraguayan RUC Number |\n| Peru | `pe_ruc` | Peruvian RUC Number |\n| Philippines | `ph_tin` | Philippines Tax Identification Number |\n| Poland | `eu_vat` | European VAT Number |\n| Poland | `pl_nip` | Polish Tax ID Number |\n| Portugal | `eu_vat` | European VAT Number |\n| Romania | `eu_vat` | European VAT Number |\n| Romania | `ro_tin` | Romanian Tax ID Number |\n| Russia | `ru_inn` | Russian INN |\n| Russia | `ru_kpp` | Russian KPP |\n| Saudi Arabia | `sa_vat` | Saudi Arabia VAT |\n| Senegal | `sn_ninea` | Senegal NINEA Number |\n| Serbia | `rs_pib` | Serbian PIB Number |\n| Singapore | `sg_gst` | Singaporean GST |\n| Singapore | `sg_uen` | Singaporean UEN |\n| Slovakia | `eu_vat` | European VAT Number |\n| Slovenia | `eu_vat` | European VAT Number |\n| Slovenia | `si_tin` | Slovenia Tax Number (dav\u010dna \u0161tevilka) |\n| South Africa | `za_vat` | South African VAT Number |\n| South Korea | `kr_brn` | Korean BRN |\n| Spain | `es_cif` | Spanish NIF Number (previously Spanish CIF Number) |\n| Spain | `eu_vat` | European VAT Number |\n| Sri Lanka | `lk_vat` | Sri Lanka VAT Number |\n| Suriname | `sr_fin` | Suriname FIN Number |\n| Sweden | `eu_vat` | European VAT Number |\n| Switzerland | `ch_uid` | Switzerland UID Number |\n| Switzerland | `ch_vat` | Switzerland VAT Number |\n| Taiwan | `tw_vat` | Taiwanese VAT |\n| Tajikistan | `tj_tin` | Tajikistan Tax Identification Number |\n| Tanzania | `tz_vat` | Tanzania VAT Number |\n| Thailand | `th_vat` | Thai VAT |\n| Turkey | `tr_tin` | Turkish Tax Identification Number |\n| Uganda | `ug_tin` | Uganda Tax Identification Number |\n| Ukraine | `ua_vat` | Ukrainian VAT |\n| United Arab Emirates | `ae_trn` | United Arab Emirates TRN |\n| United Kingdom | `gb_vat` | United Kingdom VAT Number |\n| United States | `us_ein` | United States EIN |\n| Uruguay | `uy_ruc` | Uruguayan RUC Number |\n| Uzbekistan | `uz_tin` | Uzbekistan TIN Number |\n| Uzbekistan | `uz_vat` | Uzbekistan VAT Number |\n| Venezuela | `ve_rif` | Venezuelan RIF Number |\n| Vietnam | `vn_tin` | Vietnamese Tax ID Number |\n| Zambia | `zm_tin` | Zambia Tax Identification Number |\n| Zimbabwe | `zw_tin` | Zimbabwe Tax Identification Number |"
},
"Customers": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Customer"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Customers"
},
"DEPRECATED_InvoiceLevelDiscount": {
"title": "DEPRECATED_InvoiceLevelDiscount",
"deprecated": true
},
"DailyCreditAllowanceConfig": {
"properties": {
"event_day_property": {
"type": "string",
"minLength": 1,
"title": "Event Day Property",
"description": "Event property whose value identifies the day bucket the event belongs to (e.g. 'event_day' set to an ISO date string in the customer's timezone). The allowance resets per distinct value of this property."
},
"dimensions": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"maxItems": 2,
"minItems": 1,
"title": "Dimensions",
"description": "One or two event property values to evaluate matrix groups by"
},
"default_unit_amount": {
"type": "string",
"title": "Default Unit Amount",
"description": "Default per-unit credit rate for any usage not bucketed into a specified matrix_value"
},
"daily_allowance": {
"type": "string",
"title": "Daily Allowance",
"description": "Credits granted per day. Lose-it-or-use-it; does not roll over."
},
"matrix_values": {
"items": {
"$ref": "#/components/schemas/DailyCreditAllowanceMatrixValue"
},
"type": "array",
"minItems": 1,
"title": "Matrix Values",
"description": "Per-dimension credit rates"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"event_day_property",
"dimensions",
"default_unit_amount",
"daily_allowance",
"matrix_values"
],
"title": "DailyCreditAllowanceConfig",
"description": "Pricing model that gives a daily credit budget across one or more dimensional rates.\n\nEach event is rated in credits at a per-dimension `unit_amount`. Events are bucketed into\ndays via an `event_day_property` set on the event (e.g. an ISO date string in the customer's\ntimezone, supplied at ingest by the customer). Within each day the first `daily_allowance`\ncredits are free; usage beyond that is charged in full. The allowance does not roll over.\n\nUse cases: shared daily AI-token budgets where different models have different credit costs."
},
"DailyCreditAllowanceMatrixValue": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Credits charged per unit of usage matching the specified dimension_values"
},
"dimension_values": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimension Values",
"description": "One or two matrix keys to filter usage to this value by. For example, [\"model\"] could be used to apply a different credit rate to each AI model."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount",
"dimension_values"
],
"title": "DailyCreditAllowanceMatrixValue",
"description": "Per-dimension credit price for the daily credit allowance model."
},
"DailyCreditAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"daily_credit_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"daily_credit_allowance_config": {
"$ref": "#/components/schemas/DailyCreditAllowanceConfig",
"description": "Configuration for daily_credit_allowance pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"daily_credit_allowance_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "DailyCreditAllowancePrice"
},
"DeactivateLicense": {
"properties": {
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The date to deactivate the license. If not provided, defaults to end of day today in the customer's timezone.",
"examples": [
"2026-01-27"
]
}
},
"additionalProperties": false,
"type": "object",
"title": "DeactivateLicense"
},
"Debug": {
"properties": {
"duplicate": {
"items": {
"type": "string"
},
"type": "array",
"title": "Duplicate"
},
"ingested": {
"items": {
"type": "string"
},
"type": "array",
"title": "Ingested"
}
},
"type": "object",
"required": [
"duplicate",
"ingested"
],
"title": "Debug"
},
"DecrementLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"decrement"
],
"title": "Entry Type"
},
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id"
},
"invoice_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Id"
},
"event_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Event Id",
"description": "This field is deprecated and will always be null. Decrements are not associated with individual events.",
"deprecated": true
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type"
],
"title": "DecrementLedgerEntry"
},
"DeprecatedEventResult": {
"properties": {
"deprecated": {
"type": "string",
"title": "Deprecated",
"description": "event_id of the deprecated event, if successfully updated"
}
},
"type": "object",
"required": [
"deprecated"
],
"title": "DeprecatedEventResult"
},
"DimensionalPriceConfiguration": {
"properties": {
"dimensional_price_group_id": {
"type": "string",
"title": "Dimensional Price Group Id"
},
"dimension_values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Dimension Values"
}
},
"type": "object",
"required": [
"dimensional_price_group_id",
"dimension_values"
],
"title": "DimensionalPriceConfiguration"
},
"DimensionalPriceGroup": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the dimensional price group"
},
"external_dimensional_price_group_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Dimensional Price Group Id",
"description": "An alias for the dimensional price group",
"examples": [
"my_dimensional_price_group_id"
]
},
"dimensions": {
"items": {
"type": "string"
},
"type": "array",
"minItems": 1,
"title": "Dimensions",
"description": "The dimensions that this dimensional price group is defined over",
"examples": [
[
"region",
"instance_type"
],
[
"size"
]
]
},
"billable_metric_id": {
"type": "string",
"title": "Billable Metric Id",
"description": "The billable metric associated with this dimensional price group. All prices associated with this dimensional price group will be computed using this billable metric."
}
},
"type": "object",
"required": [
"metadata",
"id",
"name",
"external_dimensional_price_group_id",
"dimensions",
"billable_metric_id"
],
"title": "DimensionalPriceGroup",
"description": "A dimensional price group is used to partition the result of a billable metric by a set of dimensions. Prices in a\nprice group must specify the partition used to derive their usage."
},
"DimensionalPriceGroups": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/DimensionalPriceGroup"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "DimensionalPriceGroups"
},
"Discount": {
"oneOf": [
{
"$ref": "#/components/schemas/PercentageDiscount"
},
{
"$ref": "#/components/schemas/TrialDiscount"
},
{
"$ref": "#/components/schemas/UsageDiscount"
},
{
"$ref": "#/components/schemas/AmountDiscount"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscount",
"percentage": "#/components/schemas/PercentageDiscount",
"trial": "#/components/schemas/TrialDiscount",
"usage": "#/components/schemas/UsageDiscount"
}
}
},
"DiscountOverride": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage",
"usage",
"amount"
],
"title": "Discount Type"
},
"percentage_discount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Percentage Discount",
"description": "Only available if discount_type is `percentage`. This is a number between 0 and 1.",
"examples": [
0.15
]
},
"usage_discount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Usage Discount",
"description": "Only available if discount_type is `usage`. Number of usage units that this discount is for"
},
"amount_discount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount Discount",
"description": "Only available if discount_type is `amount`."
}
},
"type": "object",
"required": [
"discount_type"
],
"title": "DiscountOverride"
},
"DuplicateResourceCreationError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#400-duplicate-resource-creation"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
400
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "DuplicateResourceCreationError"
},
"EditAdjustmentIntervalParams": {
"properties": {
"adjustment_interval_id": {
"type": "string",
"title": "Adjustment Interval Id",
"description": "The id of the adjustment interval to edit.",
"examples": [
"sdfs6wdjvn7ujokd"
]
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
}
],
"title": "Start Date",
"description": "The updated start date of this adjustment interval. If not specified, the start date will not be updated.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The updated end date of this adjustment interval. If not specified, the end date will not be updated.",
"examples": [
"2023-07-10"
]
}
},
"type": "object",
"required": [
"adjustment_interval_id"
],
"title": "EditAdjustmentIntervalParams"
},
"EditCustomer": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The full name of the customer"
},
"email": {
"oneOf": [
{
"type": "string",
"format": "email"
},
{
"type": "null"
}
],
"title": "Email",
"description": "A valid customer email, to be used for invoicing and notifications."
},
"payment_provider_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Provider Id",
"description": "The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb."
},
"payment_provider": {
"oneOf": [
{
"type": "string",
"enum": [
"quickbooks",
"bill.com",
"stripe_charge",
"stripe_invoice",
"netsuite"
]
},
{
"type": "null"
}
],
"title": "Payment Provider",
"description": "This is used for creating charges or invoices in an external system via Orb. When not in test mode:\n- the connection must first be configured in the Orb webapp. \n- if the provider is an invoicing provider (`stripe_invoice`, `quickbooks`, `bill.com`, `netsuite`), any product mappings must first be configured with the Orb team."
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressInput"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressInput"
},
{
"type": "null"
}
]
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string used for the customer's invoices and balance. This can only be set if the customer does not already have a currency configured. If not set at creation or update time, it will be set at subscription creation time."
},
"tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Used to determine if invoices for this customer will automatically attempt to charge a saved payment method, if available. This parameter defaults to `True` when a payment provider is provided on customer creation."
},
"auto_issuance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Issuance",
"description": "Used to determine if invoices for this customer will be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval.If `null` is specified, the customer's auto issuance setting will be inherited from the account-level setting."
},
"additional_emails": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Additional Emails",
"description": "Additional email addresses for this customer. If populated, these email addresses will be CC'd for customer communications. The total number of email addresses (including the primary email) cannot exceed 50."
},
"email_delivery": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Email Delivery"
},
"tax_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewTaxConfiguration"
},
{
"type": "null"
}
]
},
"reporting_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewReportingConfiguration"
},
{
"type": "null"
}
]
},
"accounting_sync_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAccountingSyncConfiguration"
},
{
"type": "null"
}
]
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The external customer ID. This can only be set if the customer has no existing external customer ID. Since this action may change usage quantities for all existing subscriptions, it is disallowed if the customer has issued invoices with usage line items and subject to the same restrictions as backdated subscription creation."
},
"hierarchy": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerHierarchyConfig"
},
{
"type": "null"
}
],
"description": "The hierarchical relationships for this customer."
},
"payment_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/PaymentConfiguration"
},
{
"type": "null"
}
],
"description": "Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe."
}
},
"additionalProperties": false,
"type": "object",
"title": "EditCustomer"
},
"EditDimensionalPriceGroup": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_dimensional_price_group_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Dimensional Price Group Id",
"description": "An optional user-defined ID for this dimensional price group resource, used throughout the system as an alias for this dimensional price group. Use this field to identify a dimensional price group by an existing identifier in your system."
}
},
"additionalProperties": false,
"type": "object",
"title": "EditDimensionalPriceGroup"
},
"EditPlan": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system."
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional user-defined description of the plan."
}
},
"additionalProperties": false,
"type": "object",
"title": "EditPlan"
},
"EditPriceIntervalParams": {
"properties": {
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer's customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer's children."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.",
"examples": [
"my_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"price_interval_id": {
"type": "string",
"title": "Price Interval Id",
"description": "The id of the price interval to edit.",
"examples": [
"sdfs6wdjvn7ujokd"
]
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
}
],
"title": "Start Date",
"description": "The updated start date of this price interval. If not specified, the start date will not be updated.",
"examples": [
"2023-05-01"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "string",
"enum": [
"start_of_term"
],
"title": "start_of_term"
},
{
"type": "string",
"enum": [
"end_of_term"
],
"title": "end_of_term"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The updated end date of this price interval. If not specified, the end date will not be updated.",
"examples": [
"2023-07-10"
]
},
"fixed_fee_quantity_transitions": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceIntervalFixedFeeQuantityTransitionParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fixed Fee Quantity Transitions",
"description": "A list of fixed fee quantity transitions to use for this price interval. Note that this list will overwrite all existing fixed fee quantity transitions on the price interval."
},
"billing_cycle_day": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Billing Cycle Day",
"description": "The updated billing cycle day for this price interval. If not specified, the billing cycle day will not be updated. Note that overlapping price intervals must have the same billing cycle day."
},
"can_defer_billing": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Can Defer Billing",
"description": "If true, an in-arrears price interval ending mid-cycle will defer billing the final line item until the next scheduled invoice. If false, it will be billed on its end date."
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Override values for parameterized billable metric variables. Keys are parameter names, values are the override values (number or string)."
}
},
"type": "object",
"required": [
"price_interval_id"
],
"title": "EditPriceIntervalParams"
},
"EvaluateMultiplePriceResource": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EvaluatePriceResourceForMultiplePrice"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "EvaluateMultiplePriceResource"
},
"EvaluateMultiplePricesBody": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The ID of the customer to which this evaluation is scoped."
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The external customer ID of the customer to which this evaluation is scoped."
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The inclusive lower bound for event timestamps"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The exclusive upper bound for event timestamps"
},
"price_evaluations": {
"items": {
"$ref": "#/components/schemas/PriceEvaluationRequest"
},
"type": "array",
"maxItems": 100,
"minItems": 1,
"title": "Price Evaluations",
"description": "List of prices to evaluate (max 100)",
"default": []
}
},
"additionalProperties": false,
"type": "object",
"required": [
"timeframe_start",
"timeframe_end"
],
"title": "EvaluateMultiplePricesBody"
},
"EvaluateMultiplePricesWithPreviewEventsBody": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The ID of the customer to which this evaluation is scoped."
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The external customer ID of the customer to which this evaluation is scoped."
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The inclusive lower bound for event timestamps"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The exclusive upper bound for event timestamps"
},
"events": {
"items": {
"$ref": "#/components/schemas/PreviewEvent"
},
"type": "array",
"maxItems": 500,
"minItems": 1,
"title": "Events",
"description": "List of preview events to use instead of actual usage data",
"default": []
},
"price_evaluations": {
"items": {
"$ref": "#/components/schemas/PriceEvaluationRequest"
},
"type": "array",
"maxItems": 100,
"minItems": 1,
"title": "Price Evaluations",
"description": "List of prices to evaluate (max 100)",
"default": []
}
},
"additionalProperties": false,
"type": "object",
"required": [
"timeframe_start",
"timeframe_end"
],
"title": "EvaluateMultiplePricesWithPreviewEventsBody"
},
"EvaluatePriceBody": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The ID of the customer to which this evaluation is scoped."
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The external customer ID of the customer to which this evaluation is scoped."
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The inclusive lower bound for event timestamps"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The exclusive upper bound for event timestamps"
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the underlying billable metric",
"examples": [
"my_numeric_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"grouping_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Grouping Keys",
"description": "Properties (or [computed properties](/extensibility/advanced-metrics#computed-properties)) used to group the underlying billable metric",
"default": [],
"examples": [
[
"case when my_event_type = 'foo' then true else false end"
],
[
"hour_floor_timestamp_millis(timestamp_millis)",
"my_property"
]
]
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Optional overrides for parameterized billable metric parameters. If the metric has parameter definitions and no overrides are provided, defaults will be used."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"timeframe_start",
"timeframe_end"
],
"title": "EvaluatePriceBody"
},
"EvaluatePriceGroup": {
"properties": {
"grouping_values": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "number"
},
{
"type": "boolean"
}
]
},
"type": "array",
"title": "Grouping Values",
"description": "The values for the group in the order specified by `grouping_keys`"
},
"quantity": {
"type": "number",
"title": "Quantity",
"description": "The price's usage quantity for the group"
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The price's output for the group"
}
},
"type": "object",
"required": [
"grouping_values",
"quantity",
"amount"
],
"title": "EvaluatePriceGroup"
},
"EvaluatePriceResource": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EvaluatePriceGroup"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "EvaluatePriceResource"
},
"EvaluatePriceResourceForMultiplePrice": {
"properties": {
"price_groups": {
"items": {
"$ref": "#/components/schemas/EvaluatePriceGroup"
},
"type": "array",
"title": "Price Groups",
"description": "The computed price groups associated with input price."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "The currency of the price"
},
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The ID of the price"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external ID of the price"
},
"inline_price_index": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Inline Price Index",
"description": "The index of the inline price"
}
},
"type": "object",
"required": [
"price_groups",
"currency"
],
"title": "EvaluatePriceResourceForMultiplePrice"
},
"Event": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "A unique value, generated by the client, that is used to de-duplicate events. Exactly one event with a given idempotency key will be ingested, which allows for safe request retries."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb Customer identifier"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An alias for the Orb customer, whose mapping is specified when creating the customer"
},
"event_name": {
"type": "string",
"title": "Event Name",
"description": "A name to meaningfully identify the action or event type."
},
"properties": {
"additionalProperties": true,
"type": "object",
"minProperties": 1,
"title": "Properties",
"description": "A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.",
"examples": [
"2020-12-09T16:09:53Z"
]
},
"deprecated": {
"type": "boolean",
"title": "Deprecated",
"description": "A boolean indicating whether the event is currently deprecated."
}
},
"type": "object",
"required": [
"id",
"customer_id",
"external_customer_id",
"event_name",
"properties",
"timestamp",
"deprecated"
],
"title": "Event",
"description": "The [Event](/core-concepts#event) resource represents a usage event that has been created for a\ncustomer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for\na given billing period."
},
"EventOutputConfig": {
"properties": {
"unit_rating_key": {
"type": "string",
"minLength": 1,
"title": "Unit Rating Key",
"description": "The key in the event data to extract the unit rate from."
},
"grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grouping Key",
"description": "An optional key in the event data to group by (e.g., event ID). All events will also be grouped by their unit rate."
},
"default_unit_rate": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Unit Rate",
"description": "If provided, this amount will be used as the unit rate when an event does not have a value for the `unit_rating_key`. If not provided, events missing a unit rate will be ignored."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_rating_key"
],
"title": "EventOutputConfig"
},
"EventOutputPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"event_output"
],
"title": "Model Type",
"description": "The pricing model type"
},
"event_output_config": {
"$ref": "#/components/schemas/EventOutputConfig",
"description": "Configuration for event_output pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"event_output_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "EventOutputPrice"
},
"EventSearchCriteria": {
"properties": {
"event_ids": {
"items": {
"type": "string"
},
"type": "array",
"maxItems": 500,
"minItems": 1,
"title": "Event Ids",
"description": "This is an explicit array of IDs to filter by. Note that an event's ID is the idempotency_key that was originally used for ingestion, and this only supports events that have not been amended. Values in this array will be treated case sensitively."
},
"timeframe_start": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "The start of the timeframe, inclusive, in which to search events. If not specified, the one week ago is used."
},
"timeframe_end": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "The end of the timeframe, exclusive, in which to search events. If not specified, the current time is used."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"event_ids"
],
"title": "EventSearchCriteria"
},
"EventVolume": {
"properties": {
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End"
},
"count": {
"type": "integer",
"title": "Count",
"description": "The number of events ingested with a timestamp between the timeframe"
}
},
"type": "object",
"required": [
"timeframe_start",
"timeframe_end",
"count"
],
"title": "EventVolume",
"description": "An EventVolume contains the event volume ingested in an hourly window. The timestamp used\nfor the aggregation is the `timestamp` datetime field on events."
},
"EventVolumeParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The start of the timeframe, inclusive, in which to return event volume. All datetime values are converted to UTC time. If the specified time isn't hour-aligned, the response includes the event volume count for the hour the time falls in."
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The end of the timeframe, exclusive, in which to return event volume. If not specified, the current time is used. All datetime values are converted to UTC time.If the specified time isn't hour-aligned, the response includes the event volumecount for the hour the time falls in.",
"examples": [
"2024-10-11T06:00:00Z"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"timeframe_start"
],
"title": "EventVolumeParams"
},
"EventVolumes": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/EventVolume"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "EventVolumes"
},
"Events": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Event"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "Events"
},
"ExpirationChangeLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"expiration_change"
],
"title": "Entry Type"
},
"new_block_expiry_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "New Block Expiry Date"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type",
"new_block_expiry_date"
],
"title": "ExpirationChangeLedgerEntry"
},
"FeatureNotAvailableError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#404-feature-not-available"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
400
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "FeatureNotAvailableError"
},
"FetchCustomerCreditBlocksQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"include_all_blocks": {
"type": "boolean",
"title": "Include All Blocks",
"description": "If set to True, all expired and depleted blocks, as well as active block will be returned.",
"default": false
},
"effective_date[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gte]"
},
"effective_date[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Gt]"
},
"effective_date[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lt]"
},
"effective_date[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "FetchCustomerCreditBlocksQueryParams"
},
"FetchCustomerCreditLedgerQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 500.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The ledger currency or custom pricing unit to use."
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"entry_type": {
"oneOf": [
{
"type": "string",
"enum": [
"increment",
"decrement",
"expiration_change",
"credit_block_expiry",
"void",
"void_initiated",
"amendment"
]
},
{
"type": "null"
}
],
"title": "Entry Type"
},
"entry_status": {
"oneOf": [
{
"type": "string",
"enum": [
"committed",
"pending"
]
},
{
"type": "null"
}
],
"title": "Entry Status"
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "FetchCustomerCreditLedgerQueryParams"
},
"FetchLicenseByExternalId": {
"properties": {
"subscription_id": {
"type": "string",
"title": "Subscription Id",
"description": "The ID of the subscription to fetch the license for."
},
"license_type_id": {
"type": "string",
"title": "License Type Id",
"description": "The ID of the license type to fetch the license for."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id",
"license_type_id"
],
"title": "FetchLicenseByExternalId"
},
"FetchSubscriptionScheduleQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"start_date[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Gte]"
},
"start_date[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Gt]"
},
"start_date[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Lt]"
},
"start_date[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "FetchSubscriptionScheduleQueryParams"
},
"FetchUpcomingInvoiceParams": {
"properties": {
"subscription_id": {
"type": "string",
"title": "Subscription Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id"
],
"title": "FetchUpcomingInvoiceParams"
},
"FilterRule": {
"properties": {
"property_key": {
"type": "string",
"minLength": 1,
"title": "Property Key",
"description": "Event property key to filter on"
},
"property_value": {
"type": "string",
"minLength": 1,
"title": "Property Value",
"description": "Event property value to match"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"property_key",
"property_value"
],
"title": "FilterRule",
"description": "Configuration for a single property filter"
},
"FixedFeeQuantityChange": {
"properties": {
"price_id": {
"type": "string",
"title": "Price Id",
"description": "Price for which the quantity should be updated. Must be a fixed fee."
},
"quantity": {
"type": "number",
"title": "Quantity"
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Effective Date",
"description": "The date that the quantity change should take effect, localized to the customer's timezone. If this parameter is not passed in, the quantity change is effective according to `change_option`.",
"examples": [
"2022-12-21"
]
},
"change_option": {
"type": "string",
"enum": [
"immediate",
"upcoming_invoice",
"effective_date"
],
"title": "Change Option",
"description": "Determines when the change takes effect. Note that if `effective_date` is specified, this defaults to `effective_date`. Otherwise, this defaults to `immediate` unless it's explicitly set to `upcoming_invoice`.",
"default": "immediate"
},
"allow_invoice_credit_or_void": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Invoice Credit Or Void",
"description": "If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"price_id",
"quantity"
],
"title": "FixedFeeQuantityChange"
},
"FixedFeeQuantityScheduleEntry": {
"properties": {
"price_id": {
"type": "string",
"title": "Price Id"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date"
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
},
"quantity": {
"type": "number",
"title": "Quantity"
}
},
"type": "object",
"required": [
"price_id",
"start_date",
"end_date",
"quantity"
],
"title": "FixedFeeQuantityScheduleEntry"
},
"FixedFeeQuantityTransition": {
"properties": {
"price_id": {
"type": "string",
"title": "Price Id"
},
"effective_date": {
"type": "string",
"format": "date-time",
"title": "Effective Date"
},
"quantity": {
"type": "integer",
"title": "Quantity"
}
},
"type": "object",
"required": [
"price_id",
"effective_date",
"quantity"
],
"title": "FixedFeeQuantityTransition"
},
"GroupedAllocationConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "How to determine the groups that should each be allocated some quantity"
},
"overage_unit_rate": {
"type": "string",
"title": "Overage Unit Rate",
"description": "Unit rate for post-allocation"
},
"allocation": {
"type": "string",
"title": "Allocation",
"description": "Usage allocation per group"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"overage_unit_rate",
"allocation"
],
"title": "GroupedAllocationConfig",
"description": "Configuration for grouped allocation pricing"
},
"GroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_allocation_config": {
"$ref": "#/components/schemas/GroupedAllocationConfig",
"description": "Configuration for grouped_allocation pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_allocation_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedAllocationPrice"
},
"GroupedSubscriptionUsage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/GroupedSubscriptionUsageRecord"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"oneOf": [
{
"$ref": "#/components/schemas/PaginationMetadata"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"data"
],
"title": "GroupedSubscriptionUsage"
},
"GroupedSubscriptionUsageRecord": {
"properties": {
"usage": {
"items": {
"$ref": "#/components/schemas/Usage"
},
"type": "array",
"title": "Usage"
},
"billable_metric": {
"$ref": "#/components/schemas/BillableMetricSimple"
},
"metric_group": {
"$ref": "#/components/schemas/MetricGroup"
},
"view_mode": {
"type": "string",
"enum": [
"periodic",
"cumulative"
],
"title": "View Mode"
}
},
"type": "object",
"required": [
"usage",
"billable_metric",
"metric_group",
"view_mode"
],
"title": "GroupedSubscriptionUsageRecord"
},
"GroupedTieredConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/GroupedTieredTier"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Apply tiered pricing to each segment generated after grouping with the provided key"
},
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The billable metric property used to group before tiering"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"grouping_key"
],
"title": "GroupedTieredConfig",
"description": "Configuration for grouped tiered pricing"
},
"GroupedTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_package_config": {
"$ref": "#/components/schemas/GroupedTieredPackagePricingConfig",
"description": "Configuration for grouped_tiered_package pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_tiered_package_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedTieredPackagePrice"
},
"GroupedTieredPackagePricingConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/GroupedTieredPackageTierItem"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds."
},
"package_size": {
"type": "string",
"title": "Package Size"
},
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The event property used to group before tiering"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"package_size",
"grouping_key"
],
"title": "GroupedTieredPackagePricingConfig",
"description": "Configuration for grouped tiered package pricing"
},
"GroupedTieredPackageTierItem": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"per_unit": {
"type": "string",
"title": "Per Unit",
"description": "Per package"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"per_unit"
],
"title": "GroupedTieredPackageTierItem",
"description": "Configuration for a single tier"
},
"GroupedTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_config": {
"$ref": "#/components/schemas/GroupedTieredConfig",
"description": "Configuration for grouped_tiered pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_tiered_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedTieredPrice"
},
"GroupedTieredTier": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per unit amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"unit_amount"
],
"title": "GroupedTieredTier",
"description": "Configuration for a single tier"
},
"GroupedWithMeteredMinimumConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "Used to partition the usage into groups. The minimum amount is applied to each group."
},
"pricing_key": {
"type": "string",
"title": "Pricing Key",
"description": "Used to determine the unit rate"
},
"scaling_key": {
"type": "string",
"title": "Scaling Key",
"description": "Used to determine the unit rate scaling factor"
},
"scaling_factors": {
"items": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumScalingFactorItem"
},
"type": "array",
"minItems": 1,
"title": "Scaling Factors",
"description": "Scale the unit rates by the scaling factor."
},
"unit_amounts": {
"items": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumUnitAmountItem"
},
"type": "array",
"minItems": 1,
"title": "Unit Amounts",
"description": "Apply per unit pricing to each pricing value. The minimum amount is applied any unmatched usage."
},
"minimum_unit_amount": {
"type": "string",
"title": "Minimum Unit Amount",
"description": "The minimum amount to charge per group per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"pricing_key",
"scaling_key",
"scaling_factors",
"unit_amounts",
"minimum_unit_amount"
],
"title": "GroupedWithMeteredMinimumConfig",
"description": "Configuration for grouped with metered minimum pricing"
},
"GroupedWithMeteredMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_metered_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_metered_minimum_config": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumConfig",
"description": "Configuration for grouped_with_metered_minimum pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_with_metered_minimum_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedWithMeteredMinimumPrice"
},
"GroupedWithMeteredMinimumScalingFactorItem": {
"properties": {
"scaling_value": {
"type": "string",
"title": "Scaling Value"
},
"scaling_factor": {
"type": "string",
"title": "Scaling Factor"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"scaling_value",
"scaling_factor"
],
"title": "GroupedWithMeteredMinimumScalingFactorItem",
"description": "Configuration for a scaling factor"
},
"GroupedWithMeteredMinimumUnitAmountItem": {
"properties": {
"pricing_value": {
"type": "string",
"title": "Pricing Value"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per unit amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"pricing_value",
"unit_amount"
],
"title": "GroupedWithMeteredMinimumUnitAmountItem",
"description": "Configuration for a unit amount"
},
"GroupedWithMinMaxThresholdsConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The event property used to group before applying thresholds"
},
"per_unit_rate": {
"type": "string",
"title": "Per Unit Rate",
"description": "The base price charged per group"
},
"minimum_charge": {
"type": "string",
"title": "Minimum Charge",
"description": "The minimum amount to charge each group, regardless of usage"
},
"maximum_charge": {
"type": "string",
"title": "Maximum Charge",
"description": "The maximum amount to charge each group"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"per_unit_rate",
"minimum_charge",
"maximum_charge"
],
"title": "GroupedWithMinMaxThresholdsConfig",
"description": "Configuration for grouped with minimum and maximum thresholds pricing"
},
"GroupedWithMinMaxThresholdsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_min_max_thresholds"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_min_max_thresholds_config": {
"$ref": "#/components/schemas/GroupedWithMinMaxThresholdsConfig",
"description": "Configuration for grouped_with_min_max_thresholds pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_with_min_max_thresholds_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedWithMinMaxThresholdsPrice"
},
"GroupedWithProratedMinimumConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "How to determine the groups that should each have a minimum"
},
"unit_rate": {
"type": "string",
"title": "Unit Rate",
"description": "The amount to charge per unit"
},
"minimum": {
"type": "string",
"title": "Minimum",
"description": "The minimum amount to charge per group"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"unit_rate",
"minimum"
],
"title": "GroupedWithProratedMinimumConfig",
"description": "Configuration for grouped with prorated minimum pricing"
},
"GroupedWithProratedMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_prorated_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_prorated_minimum_config": {
"$ref": "#/components/schemas/GroupedWithProratedMinimumConfig",
"description": "Configuration for grouped_with_prorated_minimum pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"grouped_with_prorated_minimum_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "GroupedWithProratedMinimumPrice"
},
"IdempotencyRequestMismatch": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#409-resource-conflict"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
409
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "IdempotencyRequestMismatch"
},
"IncrementCreditLedgerEntryInvoiceSettings": {
"properties": {
"auto_collection": {
"type": "boolean",
"title": "Auto Collection",
"description": "Whether the credits purchase invoice should auto collect with the customer's saved payment method."
},
"net_terms": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the due date of the invoice. Due date is calculated based on the invoice or issuance date, depending on the account's configured due date calculation method. A value of '0' here represents that the invoice is due on issue, whereas a value of '30' represents that the customer has 30 days to pay the invoice. You must set either `net_terms` or `custom_due_date`, but not both."
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo to display on the invoice."
},
"require_successful_payment": {
"type": "boolean",
"title": "Require Successful Payment",
"description": "If true, the new credit block will require that the corresponding invoice is paid before it can be drawn down from.",
"default": false
},
"invoice_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date",
"description": "An ISO 8601 format date that denotes when this invoice should be dated in the customer's timezone. If not provided, the invoice date will default to the credit block's effective date."
},
"custom_due_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Custom Due Date",
"description": "An optional custom due date for the invoice. If not set, the due date will be calculated based on the `net_terms` value."
},
"item_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Item Id",
"description": "The ID of the Item to be used for the invoice line item. If not provided, a default 'Credits' item will be used."
},
"mark_as_paid": {
"type": "boolean",
"title": "Mark As Paid",
"description": "If true, the new credits purchase invoice will be marked as paid.",
"default": false
}
},
"type": "object",
"required": [
"auto_collection"
],
"title": "IncrementCreditLedgerEntryInvoiceSettings"
},
"IncrementLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"increment"
],
"title": "Entry Type"
},
"created_invoices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/Invoice"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Created Invoices",
"description": "If the increment resulted in invoice creation, the list of created invoices"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type"
],
"title": "IncrementLedgerEntry"
},
"IngestEventIdempotencyKeyOnly": {
"properties": {
"idempotency_key": {
"type": "string",
"title": "Idempotency Key"
}
},
"additionalProperties": true,
"type": "object",
"required": [
"idempotency_key"
],
"title": "IngestEventIdempotencyKeyOnly"
},
"IngestQueryParams": {
"properties": {
"debug": {
"type": "boolean",
"title": "Debug",
"description": "Pending Deprecation: Flag to enable additional debug information in the endpoint response",
"default": false,
"deprecated": true
},
"backfill_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Backfill Id",
"description": "If this ingestion request is part of a backfill, this parameter ties the ingested events to the backfill"
}
},
"additionalProperties": false,
"type": "object",
"title": "IngestQueryParams"
},
"IngestRequestBody": {
"properties": {
"events": {
"items": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb Customer identifier"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An alias for the Orb customer, whose mapping is specified when creating the customer"
},
"event_name": {
"type": "string",
"title": "Event Name",
"description": "A name to meaningfully identify the action or event type."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.",
"examples": [
"2020-12-09T16:09:53Z"
]
},
"properties": {
"additionalProperties": true,
"type": "object",
"title": "Properties",
"description": "A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed."
},
"idempotency_key": {
"type": "string",
"title": "Idempotency Key",
"description": "A unique value, generated by the client, that is used to de-duplicate events. Exactly one event with a given idempotency key will be ingested, which allows for safe request retries."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"event_name",
"timestamp",
"properties",
"idempotency_key"
],
"title": "IngestEvent"
},
"type": "array",
"title": "Events"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"events"
],
"title": "IngestRequestBody"
},
"IngestionResponse": {
"properties": {
"debug": {
"oneOf": [
{
"$ref": "#/components/schemas/Debug"
},
{
"type": "null"
}
],
"description": "Optional debug information (only present when debug=true is passed to the endpoint). Contains ingested and duplicate event idempotency keys."
},
"validation_failed": {
"items": {
"$ref": "#/components/schemas/ValidationError"
},
"type": "array",
"title": "Validation Failed",
"description": "Contains all failing validation events. In the case of a 200, this array will always be empty. This field will always be present."
}
},
"type": "object",
"required": [
"validation_failed"
],
"title": "IngestionResponse"
},
"Invoice": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "If the invoice has a status of `void`, this gives a timestamp when the invoice was voided."
},
"paid_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Paid At",
"description": "If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid."
},
"issued_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issued At",
"description": "If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)"
},
"scheduled_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Scheduled Issue At",
"description": "If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued."
},
"auto_collection": {
"$ref": "#/components/schemas/AutoCollection"
},
"issue_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issue Failed At",
"description": "If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)"
},
"sync_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Sync Failed At",
"description": "If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing."
},
"payment_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Failed At",
"description": "If payment was attempted on this invoice but failed, this will be the time of the most recent attempt."
},
"payment_started_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Started At",
"description": "If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more."
},
"amount_due": {
"type": "string",
"title": "Amount Due",
"description": "This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.",
"examples": [
"8.00"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or `credits`",
"examples": [
"USD"
]
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "When the invoice payment is due. The due date is null if the invoice is not yet finalized.",
"examples": [
"2022-05-30T07:00:00+00:00"
]
},
"id": {
"type": "string",
"title": "Id"
},
"invoice_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Pdf",
"description": "The link to download the PDF representation of the `Invoice`.",
"examples": [
"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
]
},
"invoice_number": {
"type": "string",
"title": "Invoice Number",
"description": "Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.",
"examples": [
"JYEFHK-00001"
]
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
]
},
"total": {
"type": "string",
"title": "Total",
"description": "The total after any minimums and discounts have been applied.",
"examples": [
"8.00"
]
},
"customer_balance_transactions": {
"items": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
},
"type": "array",
"title": "Customer Balance Transactions"
},
"status": {
"type": "string",
"enum": [
"issued",
"paid",
"synced",
"void",
"draft"
],
"title": "Status"
},
"invoice_source": {
"type": "string",
"enum": [
"subscription",
"partial",
"one_off"
],
"title": "Invoice Source"
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"hosted_invoice_url": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hosted Invoice Url",
"description": "A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date \u2014 whichever is later."
},
"will_auto_issue": {
"type": "boolean",
"title": "Will Auto Issue",
"description": "This is true if the invoice will be automatically issued in the future, and false otherwise."
},
"eligible_to_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Eligible To Issue At",
"description": "If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time."
},
"customer_tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "Free-form text which is available on the invoice PDF and the Orb invoice portal."
},
"credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNoteSummary"
},
"type": "array",
"title": "Credit Notes",
"description": "A list of credit notes associated with the invoice"
},
"payment_attempts": {
"items": {
"$ref": "#/components/schemas/PaymentAttempt"
},
"type": "array",
"title": "Payment Attempts",
"description": "A list of payment attempts associated with the invoice"
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/DEPRECATED_InvoiceLevelDiscount"
},
{
"type": "null"
}
],
"description": "This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the first discount in the list will be returned. If the list is empty, `None` will be returned.",
"deprecated": true
},
"discounts": {
"items": {
"$ref": "#/components/schemas/InvoiceLevelDiscount"
},
"type": "array",
"title": "Discounts"
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
]
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount"
},
"line_items": {
"items": {
"$ref": "#/components/schemas/InvoiceLineItem"
},
"type": "array",
"title": "Line Items",
"description": "The breakdown of prices in this invoice."
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The total before any discounts and minimums are applied.",
"examples": [
"8.00"
]
},
"invoice_date": {
"type": "string",
"format": "date-time",
"title": "Invoice Date",
"description": "The scheduled date of the invoice",
"examples": [
"2022-05-01T07:00:00+00:00"
]
}
},
"type": "object",
"required": [
"metadata",
"voided_at",
"paid_at",
"issued_at",
"scheduled_issue_at",
"auto_collection",
"issue_failed_at",
"sync_failed_at",
"payment_failed_at",
"payment_started_at",
"amount_due",
"created_at",
"currency",
"customer",
"due_date",
"id",
"invoice_pdf",
"invoice_number",
"subscription",
"total",
"customer_balance_transactions",
"status",
"invoice_source",
"shipping_address",
"billing_address",
"hosted_invoice_url",
"will_auto_issue",
"eligible_to_issue_at",
"customer_tax_id",
"memo",
"credit_notes",
"payment_attempts",
"discount",
"discounts",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount",
"line_items",
"subtotal",
"invoice_date"
],
"title": "Invoice",
"description": "An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for\na single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and\ncan represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as\nthe result of an action, such as a cancellation."
},
"InvoiceLevelDiscount": {
"oneOf": [
{
"$ref": "#/components/schemas/PercentageDiscount"
},
{
"$ref": "#/components/schemas/AmountDiscount"
},
{
"$ref": "#/components/schemas/TrialDiscount"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscount",
"percentage": "#/components/schemas/PercentageDiscount",
"trial": "#/components/schemas/TrialDiscount"
}
}
},
"InvoiceLineItem": {
"properties": {
"amount": {
"type": "string",
"title": "Amount",
"description": "The final amount for a line item after all adjustments and pre paid credits have been applied.",
"examples": [
"7.00"
]
},
"end_date": {
"type": "string",
"format": "date-time",
"title": "End Date",
"description": "The end date of the range of time applied for this line item's price.",
"examples": [
"2022-02-01T08:00:00+00:00"
]
},
"grouping": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grouping",
"description": "[DEPRECATED] For configured prices that are split by a grouping key, this will be populated with the key and a value. The `amount` and `subtotal` will be the values for this particular grouping."
},
"adjustments": {
"items": {
"$ref": "#/components/schemas/MonetaryAdjustment"
},
"type": "array",
"title": "Adjustments",
"description": "All adjustments applied to the line item in the order they were applied based on invoice calculations (ie. usage discounts -> amount discounts -> percentage discounts -> minimums -> maximums)."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price associated with this line item.",
"examples": [
"Fixed Fee"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"description": "Either the fixed fee quantity or the usage during the service period.",
"examples": [
1
]
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the range of time applied for this line item's price.",
"examples": [
"2022-02-01T08:00:00+00:00"
]
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The line amount before any adjustments.",
"examples": [
"9.00"
]
},
"adjusted_subtotal": {
"type": "string",
"title": "Adjusted Subtotal",
"description": "The line amount after any adjustments and before overage conversion, credits and partial invoicing.",
"examples": [
"5.00"
]
},
"credits_applied": {
"type": "string",
"title": "Credits Applied",
"description": "The number of prepaid credits applied.",
"examples": [
"6.00"
]
},
"partially_invoiced_amount": {
"type": "string",
"title": "Partially Invoiced Amount",
"description": "Any amount applied from a partial invoice",
"examples": [
"4.00"
]
},
"sub_line_items": {
"items": {
"$ref": "#/components/schemas/InvoiceSubLineItem"
},
"type": "array",
"title": "Sub Line Items",
"description": "For complex pricing structures, the line item can be broken down further in `sub_line_items`."
},
"tax_amounts": {
"items": {
"$ref": "#/components/schemas/TaxAmount"
},
"type": "array",
"title": "Tax Amounts",
"description": "An array of tax rates and their incurred tax amounts. Empty if no tax integration is configured."
},
"id": {
"type": "string",
"title": "Id",
"description": "A unique ID for this line item."
},
"price": {
"$ref": "#/components/schemas/Price"
},
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer ids that were used to calculate the usage for this line item."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter that was used to calculate the usage for this line item."
}
},
"type": "object",
"required": [
"amount",
"end_date",
"grouping",
"adjustments",
"name",
"quantity",
"start_date",
"subtotal",
"adjusted_subtotal",
"credits_applied",
"partially_invoiced_amount",
"sub_line_items",
"tax_amounts",
"id",
"price",
"usage_customer_ids",
"filter"
],
"title": "InvoiceLineItem"
},
"InvoiceLineItemParams": {
"properties": {
"start_date": {
"type": "string",
"format": "date",
"title": "Start Date",
"description": "A date string to specify the line item's start date in the customer's timezone.",
"examples": [
"2023-09-22"
]
},
"end_date": {
"type": "string",
"format": "date",
"title": "End Date",
"description": "A date string to specify the line item's end date in the customer's timezone.",
"examples": [
"2023-09-22"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"description": "The number of units on the line item",
"examples": [
1
]
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the line item.",
"examples": [
"Line Item Name"
]
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "",
"examples": [
"4khy3nwzktxv7"
]
},
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "",
"examples": [
"unit"
]
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"start_date",
"end_date",
"quantity",
"name",
"item_id",
"model_type",
"unit_config"
],
"title": "InvoiceLineItemParams"
},
"InvoiceMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"invoice_number": {
"type": "string",
"title": "Invoice Number"
},
"status": {
"type": "string",
"enum": [
"issued",
"paid",
"synced",
"void",
"draft"
],
"title": "Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"invoice_number",
"status",
"customer",
"subscription"
],
"title": "InvoiceMinified"
},
"InvoiceSubLineItem": {
"oneOf": [
{
"$ref": "#/components/schemas/MatrixSubLineItem"
},
{
"$ref": "#/components/schemas/TierSubLineItem"
},
{
"$ref": "#/components/schemas/OtherSubLineItem"
}
],
"discriminator": {
"propertyName": "type",
"mapping": {
"'null'": "#/components/schemas/OtherSubLineItem",
"matrix": "#/components/schemas/MatrixSubLineItem",
"tier": "#/components/schemas/TierSubLineItem"
}
}
},
"InvoiceSummary": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "If the invoice has a status of `void`, this gives a timestamp when the invoice was voided."
},
"paid_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Paid At",
"description": "If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid."
},
"issued_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issued At",
"description": "If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)"
},
"scheduled_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Scheduled Issue At",
"description": "If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued."
},
"auto_collection": {
"$ref": "#/components/schemas/AutoCollection"
},
"issue_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issue Failed At",
"description": "If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)"
},
"sync_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Sync Failed At",
"description": "If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing."
},
"payment_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Failed At",
"description": "If payment was attempted on this invoice but failed, this will be the time of the most recent attempt."
},
"payment_started_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Started At",
"description": "If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more."
},
"amount_due": {
"type": "string",
"title": "Amount Due",
"description": "This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.",
"examples": [
"8.00"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or `credits`",
"examples": [
"USD"
]
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "When the invoice payment is due. The due date is null if the invoice is not yet finalized.",
"examples": [
"2022-05-30T07:00:00+00:00"
]
},
"id": {
"type": "string",
"title": "Id"
},
"invoice_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Pdf",
"description": "The link to download the PDF representation of the `Invoice`.",
"examples": [
"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
]
},
"invoice_number": {
"type": "string",
"title": "Invoice Number",
"description": "Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.",
"examples": [
"JYEFHK-00001"
]
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
]
},
"total": {
"type": "string",
"title": "Total",
"description": "The total after any minimums and discounts have been applied.",
"examples": [
"8.00"
]
},
"customer_balance_transactions": {
"items": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
},
"type": "array",
"title": "Customer Balance Transactions"
},
"status": {
"type": "string",
"enum": [
"issued",
"paid",
"synced",
"void",
"draft"
],
"title": "Status"
},
"invoice_source": {
"type": "string",
"enum": [
"subscription",
"partial",
"one_off"
],
"title": "Invoice Source"
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"hosted_invoice_url": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hosted Invoice Url",
"description": "A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date \u2014 whichever is later."
},
"will_auto_issue": {
"type": "boolean",
"title": "Will Auto Issue",
"description": "This is true if the invoice will be automatically issued in the future, and false otherwise."
},
"eligible_to_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Eligible To Issue At",
"description": "If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time."
},
"customer_tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "Free-form text which is available on the invoice PDF and the Orb invoice portal."
},
"credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNoteSummary"
},
"type": "array",
"title": "Credit Notes",
"description": "A list of credit notes associated with the invoice"
},
"payment_attempts": {
"items": {
"$ref": "#/components/schemas/PaymentAttempt"
},
"type": "array",
"title": "Payment Attempts",
"description": "A list of payment attempts associated with the invoice"
},
"invoice_date": {
"type": "string",
"format": "date-time",
"title": "Invoice Date",
"description": "The scheduled date of the invoice",
"examples": [
"2022-05-01T07:00:00+00:00"
]
}
},
"type": "object",
"required": [
"metadata",
"voided_at",
"paid_at",
"issued_at",
"scheduled_issue_at",
"auto_collection",
"issue_failed_at",
"sync_failed_at",
"payment_failed_at",
"payment_started_at",
"amount_due",
"created_at",
"currency",
"customer",
"due_date",
"id",
"invoice_pdf",
"invoice_number",
"subscription",
"total",
"customer_balance_transactions",
"status",
"invoice_source",
"shipping_address",
"billing_address",
"hosted_invoice_url",
"will_auto_issue",
"eligible_to_issue_at",
"customer_tax_id",
"memo",
"credit_notes",
"payment_attempts",
"invoice_date"
],
"title": "InvoiceSummary",
"description": "#InvoiceApiResourceWithoutLineItems"
},
"InvoiceSummarys": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/InvoiceSummary"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "InvoiceSummarys"
},
"InvoiceTiny": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The Invoice id",
"examples": [
"gXcsPTVyC4YZa3Sc"
]
}
},
"type": "object",
"required": [
"id"
],
"title": "InvoiceTiny"
},
"Invoices": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Invoice"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Invoices"
},
"IssueInvoiceRequestParams": {
"properties": {
"synchronous": {
"type": "boolean",
"title": "Synchronous",
"description": "If true, the invoice will be issued synchronously. If false, the invoice will be issued asynchronously. The synchronous option is only available for invoices that have no usage fees. If the invoice is configured to sync to an external provider, a successful response from this endpoint guarantees the invoice is present in the provider.",
"default": false,
"examples": [
true,
false
]
}
},
"additionalProperties": false,
"type": "object",
"title": "IssueInvoiceRequestParams"
},
"Item": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id",
"description": "The Orb-assigned unique identifier for the item."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the item."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The time at which the item was created."
},
"external_connections": {
"items": {
"$ref": "#/components/schemas/ItemExternalConnection"
},
"type": "array",
"title": "External Connections",
"description": "A list of external connections for this item, used to sync with external invoicing and tax systems."
},
"archived_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Archived At",
"description": "The time at which the item was archived. If null, the item is not archived."
}
},
"type": "object",
"required": [
"metadata",
"id",
"name",
"created_at",
"external_connections"
],
"title": "Item",
"description": "The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics,\nand prices and are used for defining external sync behavior for invoices and tax calculation purposes."
},
"ItemExternalConnection": {
"properties": {
"external_connection_name": {
"oneOf": [
{
"type": "string",
"enum": [
"stripe",
"quickbooks",
"bill.com",
"netsuite"
]
},
{
"type": "string",
"enum": [
"taxjar",
"avalara",
"anrok",
"numeral",
"stripe_tax"
]
}
],
"title": "External Connection Name",
"description": "The name of the external system this item is connected to."
},
"external_entity_id": {
"type": "string",
"title": "External Entity Id",
"description": "The identifier of this item in the external system."
}
},
"type": "object",
"required": [
"external_connection_name",
"external_entity_id"
],
"title": "ItemExternalConnection",
"description": "Represents a connection between an Item and an external system for invoicing or tax calculation purposes."
},
"ItemSlim": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The Orb-assigned unique identifier for the item."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the item."
}
},
"type": "object",
"required": [
"id",
"name"
],
"title": "ItemSlim",
"description": "A minimal representation of an Item containing only the essential identifying information."
},
"Items": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Item"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Items"
},
"LicenseApiResource": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"subscription_id": {
"type": "string",
"title": "Subscription Id"
},
"license_type_id": {
"type": "string",
"title": "License Type Id"
},
"external_license_id": {
"type": "string",
"title": "External License Id"
},
"status": {
"type": "string",
"enum": [
"active",
"inactive"
],
"title": "Status"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date"
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
}
},
"type": "object",
"required": [
"id",
"subscription_id",
"license_type_id",
"external_license_id",
"status",
"start_date",
"end_date"
],
"title": "LicenseApiResource"
},
"LicenseApiResources": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/LicenseApiResource"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "LicenseApiResources"
},
"LicenseType": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The Orb-assigned unique identifier for the license type."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the license type."
},
"grouping_key": {
"type": "string",
"title": "Grouping Key",
"description": "The key used for grouping licenses of this type. This is typically a user identifier field."
}
},
"type": "object",
"required": [
"id",
"name",
"grouping_key"
],
"title": "LicenseType",
"description": "The LicenseType resource represents a type of license that can be assigned to users.\nLicense types are used during billing by grouping metrics on the configured grouping key."
},
"LicenseTypeMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "LicenseTypeMinified",
"description": "Minified license type for alert serialization."
},
"LicenseTypes": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/LicenseType"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "LicenseTypes"
},
"LicenseUsage": {
"properties": {
"license_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Id",
"description": "The unique identifier for the license. Null when grouped by day only."
},
"subscription_id": {
"type": "string",
"title": "Subscription Id",
"description": "The unique identifier for the subscription."
},
"license_type_id": {
"type": "string",
"title": "License Type Id",
"description": "The unique identifier for the license type."
},
"external_license_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External License Id",
"description": "The external identifier for the license. Null when grouped by day only."
},
"start_date": {
"type": "string",
"format": "date",
"title": "Start Date",
"description": "The start date of the usage period."
},
"end_date": {
"type": "string",
"format": "date",
"title": "End Date",
"description": "The end date of the usage period."
},
"allocated_credits": {
"type": "number",
"title": "Allocated Credits",
"description": "The total credits allocated to this license for the period."
},
"consumed_credits": {
"type": "number",
"title": "Consumed Credits",
"description": "The credits consumed by this license for the period."
},
"remaining_credits": {
"type": "number",
"title": "Remaining Credits",
"description": "The remaining credits available for this license (allocated - consumed)."
},
"pricing_unit": {
"type": "string",
"title": "Pricing Unit",
"description": "The pricing unit for the credits (e.g., 'credits')."
},
"allocation_eligible_credits": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Allocation Eligible Credits",
"description": "Credits consumed while the license was active (eligible for individual allocation deduction)."
},
"shared_pool_credits": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Shared Pool Credits",
"description": "Credits consumed while the license was inactive (draws from shared pool, not individual allocation)."
}
},
"type": "object",
"required": [
"subscription_id",
"license_type_id",
"start_date",
"end_date",
"allocated_credits",
"consumed_credits",
"remaining_credits",
"pricing_unit"
],
"title": "LicenseUsage",
"description": "The LicenseUsage resource represents usage and remaining credits for a license over a date range.\n\nWhen grouped by 'day' only, license_id and external_license_id will be null as the data\nis aggregated across all licenses."
},
"LicenseUsageByExternalIdQueryParams": {
"properties": {
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"group_by": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
},
"subscription_id": {
"type": "string",
"title": "Subscription Id",
"description": "The subscription ID to get license usage for."
},
"license_type_id": {
"type": "string",
"title": "License Type Id",
"description": "The license type ID to filter licenses by."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id",
"license_type_id"
],
"title": "LicenseUsageByExternalIdQueryParams",
"description": "Query parameters for GET /v1/licenses/external_licenses//usage\n\nThe external_license_id is provided as a path parameter.\nRequires subscription_id to identify which subscription the license belongs to."
},
"LicenseUsageByTypeQueryParams": {
"properties": {
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"group_by": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
},
"subscription_id": {
"type": "string",
"title": "Subscription Id",
"description": "The subscription ID to get license usage for."
},
"license_type_id": {
"type": "string",
"title": "License Type Id",
"description": "The license type ID to filter licenses by."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id",
"license_type_id"
],
"title": "LicenseUsageByTypeQueryParams",
"description": "Query parameters for GET /v1/licenses/usage\n\nRequires subscription_id and license_type_id to get usage for all licenses\nof a given type on a subscription."
},
"LicenseUsageQueryParams": {
"properties": {
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "Start date for the usage period (YYYY-MM-DD). Defaults to start of current billing period."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "End date for the usage period (YYYY-MM-DD). Defaults to end of current billing period."
},
"group_by": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "How to group the results. Valid values: 'license', 'day'. Can be combined (e.g., 'license,day')."
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Pagination cursor from a previous request."
},
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "Maximum number of rows in the response data (default 20, max 100).",
"default": 20
}
},
"additionalProperties": false,
"type": "object",
"title": "LicenseUsageQueryParams",
"description": "Base query parameters for license usage endpoints.\nContains common parameters like date range, grouping, and pagination."
},
"LicenseUsages": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/LicenseUsage"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "LicenseUsages"
},
"ListAlertsQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "Fetch alerts scoped to this customer_id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "Fetch alerts scoped to this external_customer_id"
},
"subscription_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id",
"description": "Fetch alerts scoped to this subscription_id"
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListAlertsQueryParams"
},
"ListCreditNotesParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListCreditNotesParams"
},
"ListCustomerBalanceTransactionsQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"operation_time[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Gte]"
},
"operation_time[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Gt]"
},
"operation_time[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Lt]"
},
"operation_time[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Operation Time[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListCustomerBalanceTransactionsQueryParams"
},
"ListCustomersQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListCustomersQueryParams"
},
"ListInvoicesParams": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"subscription_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id"
},
"status": {
"oneOf": [
{
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"status[]": {
"oneOf": [
{
"items": {
"type": "string",
"enum": [
"draft",
"issued",
"paid",
"synced",
"void"
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status[]",
"explode": true
},
"due_date_window": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Due Date Window",
"description": "Filters invoices by their due dates within a specific time range in the past. Specify the range as a number followed by 'd' (days) or 'm' (months). For example, '7d' filters invoices due in the last 7 days, and '2m' filters those due in the last 2 months."
},
"date_type": {
"oneOf": [
{
"type": "string",
"enum": [
"due_date",
"invoice_date"
]
},
{
"type": "null"
}
],
"title": "Date Type",
"default": "invoice_date"
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date"
},
"due_date[gt]": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Gt]"
},
"due_date[lt]": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Due Date[Lt]"
},
"amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount"
},
"amount[gt]": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Gt]"
},
"amount[lt]": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Amount[Lt]"
},
"is_recurring": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Is Recurring"
},
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"invoice_date[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gte]"
},
"invoice_date[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Gt]"
},
"invoice_date[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lt]"
},
"invoice_date[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListInvoicesParams"
},
"ListLicensesParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"subscription_id": {
"type": "string",
"title": "Subscription Id"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id"
},
"external_license_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External License Id"
},
"status": {
"oneOf": [
{
"type": "string",
"enum": [
"active",
"inactive"
]
},
{
"type": "null"
}
],
"title": "Status"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id"
],
"title": "ListLicensesParams"
},
"ListMetricsQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListMetricsQueryParams"
},
"ListPlansQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"draft"
],
"title": "Status",
"description": "The plan status to filter to ('active', 'archived', or 'draft')."
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListPlansQueryParams"
},
"ListSubscriptionChangesQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"status": {
"oneOf": [
{
"type": "string",
"enum": [
"pending",
"applied",
"cancelled"
]
},
{
"type": "null"
}
],
"title": "Status"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListSubscriptionChangesQueryParams"
},
"ListSubscriptionsQueryParams": {
"properties": {
"limit": {
"type": "integer",
"maximum": 100.0,
"minimum": 1.0,
"title": "Limit",
"description": "The number of items to fetch. Defaults to 20.",
"default": 20
},
"cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Cursor",
"description": "Cursor for pagination. This can be populated by the `next_cursor` value returned from the initial request."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"customer_id[]": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Customer Id[]",
"explode": true
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"external_customer_id[]": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "External Customer Id[]",
"explode": true
},
"plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Id"
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id"
},
"status": {
"oneOf": [
{
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
]
},
{
"type": "null"
}
],
"title": "Status"
},
"status[]": {
"oneOf": [
{
"items": {
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
]
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Status[]",
"explode": true
},
"created_at[gte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gte]"
},
"created_at[gt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Gt]"
},
"created_at[lt]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lt]"
},
"created_at[lte]": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Created At[Lte]"
}
},
"additionalProperties": false,
"type": "object",
"title": "ListSubscriptionsQueryParams"
},
"MapItemRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name"
},
"external_connections": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ItemExternalConnection"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "External Connections"
}
},
"additionalProperties": false,
"type": "object",
"title": "MapItemRequestParams",
"description": "A list of external connections to map an item to. Note that passing `null` will clear existing mappings.\nOrb requires that you pass the full list of mappings; this list will replace the existing item mappings."
},
"MarkAsPaidRequestParams": {
"properties": {
"payment_received_date": {
"type": "string",
"format": "date",
"title": "Payment Received Date",
"description": "A date string to specify the date of the payment.",
"examples": [
"2023-09-22"
]
},
"external_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Id",
"description": "An optional external ID to associate with the payment.",
"examples": [
"external_payment_id_123"
]
},
"notes": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Notes",
"description": "An optional note to associate with the payment."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"payment_received_date"
],
"title": "MarkAsPaidRequestParams"
},
"MatrixCell": {
"properties": {
"first_dimension_value": {
"type": "string",
"title": "First Dimension Value"
},
"second_dimension_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Value"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_dimension_value",
"unit_amount"
],
"title": "MatrixCell"
},
"MatrixConfig": {
"properties": {
"dimensions": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimensions",
"description": "One or two event property values to evaluate matrix groups by"
},
"default_unit_amount": {
"type": "string",
"title": "Default Unit Amount",
"description": "Default per unit rate for any usage not bucketed into a specified matrix_value"
},
"matrix_values": {
"items": {
"$ref": "#/components/schemas/MatrixValue"
},
"type": "array",
"minItems": 1,
"title": "Matrix Values",
"description": "Matrix values configuration"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"dimensions",
"default_unit_amount",
"matrix_values"
],
"title": "MatrixConfig",
"description": "Configuration for matrix pricing"
},
"MatrixPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_config": {
"$ref": "#/components/schemas/MatrixConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"matrix_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MatrixPrice"
},
"MatrixSubLineItem": {
"properties": {
"amount": {
"type": "string",
"title": "Amount",
"description": "The total amount for this sub line item.",
"examples": [
"9.00"
]
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"Tier One"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"examples": [
5
]
},
"grouping": {
"oneOf": [
{
"$ref": "#/components/schemas/SubLineItemGrouping"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"matrix"
],
"title": "Type"
},
"scaled_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Scaled Quantity",
"description": "The scaled quantity for this line item for specific pricing structures"
},
"matrix_config": {
"$ref": "#/components/schemas/SubLineItemMatrixConfig"
}
},
"type": "object",
"required": [
"amount",
"name",
"quantity",
"grouping",
"type",
"matrix_config"
],
"title": "MatrixSubLineItem"
},
"MatrixValue": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Unit price for the specified dimension_values"
},
"dimension_values": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimension Values",
"description": "One or two matrix keys to filter usage to this Matrix value by"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount",
"dimension_values"
],
"title": "MatrixValue",
"description": "Configuration for a single matrix value"
},
"MatrixWithAllocationConfig": {
"properties": {
"dimensions": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimensions",
"description": "One or two event property values to evaluate matrix groups by"
},
"default_unit_amount": {
"type": "string",
"title": "Default Unit Amount",
"description": "Default per unit rate for any usage not bucketed into a specified matrix_value"
},
"allocation": {
"type": "string",
"title": "Allocation",
"description": "Usage allocation"
},
"matrix_values": {
"items": {
"$ref": "#/components/schemas/MatrixWithAllocationValueItem"
},
"type": "array",
"minItems": 1,
"title": "Matrix Values",
"description": "Matrix values configuration"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"dimensions",
"default_unit_amount",
"allocation",
"matrix_values"
],
"title": "MatrixWithAllocationConfig",
"description": "Configuration for matrix pricing with usage allocation"
},
"MatrixWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_allocation_config": {
"$ref": "#/components/schemas/MatrixWithAllocationConfig",
"description": "Configuration for matrix_with_allocation pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"matrix_with_allocation_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MatrixWithAllocationPrice"
},
"MatrixWithAllocationValueItem": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Unit price for the specified dimension_values"
},
"dimension_values": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimension Values",
"description": "One or two matrix keys to filter usage to this Matrix value by. For example, [\"region\", \"tier\"] could be used to filter cloud usage by a cloud region and an instance tier."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount",
"dimension_values"
],
"title": "MatrixWithAllocationValueItem",
"description": "Configuration for a single matrix value"
},
"MatrixWithDisplayNameConfig": {
"properties": {
"dimension": {
"type": "string",
"title": "Dimension",
"description": "Used to determine the unit rate"
},
"unit_amounts": {
"items": {
"$ref": "#/components/schemas/MatrixWithDisplayNameUnitAmountItem"
},
"type": "array",
"minItems": 1,
"title": "Unit Amounts",
"description": "Apply per unit pricing to each dimension value"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"dimension",
"unit_amounts"
],
"title": "MatrixWithDisplayNameConfig",
"description": "Configuration for matrix with display name pricing"
},
"MatrixWithDisplayNamePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_display_name"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_display_name_config": {
"$ref": "#/components/schemas/MatrixWithDisplayNameConfig",
"description": "Configuration for matrix_with_display_name pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"matrix_with_display_name_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MatrixWithDisplayNamePrice"
},
"MatrixWithDisplayNameUnitAmountItem": {
"properties": {
"display_name": {
"type": "string",
"title": "Display Name",
"description": "Display name for this dimension value"
},
"dimension_value": {
"type": "string",
"title": "Dimension Value",
"description": "The dimension value"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per unit amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"display_name",
"dimension_value",
"unit_amount"
],
"title": "MatrixWithDisplayNameUnitAmountItem",
"description": "Configuration for a unit amount item"
},
"MatrixWithThresholdDiscountsConfig": {
"properties": {
"first_dimension": {
"type": "string",
"title": "First Dimension",
"description": "First matrix dimension key."
},
"second_dimension": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension",
"description": "Optional second matrix dimension key."
},
"default_unit_amount": {
"type": "string",
"title": "Default Unit Amount",
"description": "Unit price used for usage that does not match any defined matrix cell."
},
"matrix_values": {
"items": {
"$ref": "#/components/schemas/MatrixCell"
},
"type": "array",
"minItems": 1,
"title": "Matrix Values",
"description": "Per-cell unit prices."
},
"threshold_discount_groups": {
"items": {
"$ref": "#/components/schemas/ThresholdDiscountGroup"
},
"type": "array",
"title": "Threshold Discount Groups"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_dimension",
"default_unit_amount",
"matrix_values"
],
"title": "MatrixWithThresholdDiscountsConfig",
"description": "Matrix pricing with per-dimension-subset threshold discounts.\n\nEach threshold-discount group targets a subset of matrix cells and applies a two-rate\ndiscount: a baseline % on spend at or below a threshold, and a steeper % on spend above."
},
"MatrixWithThresholdDiscountsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_threshold_discounts"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_threshold_discounts_config": {
"$ref": "#/components/schemas/MatrixWithThresholdDiscountsConfig",
"description": "Configuration for matrix_with_threshold_discounts pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"matrix_with_threshold_discounts_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MatrixWithThresholdDiscountsPrice"
},
"MaxGroupTieredPackageConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/MaxGroupTieredTierItem"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Apply tiered pricing to the largest group after grouping with the provided key."
},
"package_size": {
"type": "string",
"title": "Package Size"
},
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The event property used to group before tiering the group with the highest value"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"package_size",
"grouping_key"
],
"title": "MaxGroupTieredPackageConfig",
"description": "Configuration for max group tiered package pricing"
},
"MaxGroupTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"max_group_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"max_group_tiered_package_config": {
"$ref": "#/components/schemas/MaxGroupTieredPackageConfig",
"description": "Configuration for max_group_tiered_package pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"max_group_tiered_package_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MaxGroupTieredPackagePrice"
},
"MaxGroupTieredTierItem": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per unit amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"unit_amount"
],
"title": "MaxGroupTieredTierItem",
"description": "Configuration for a single tier"
},
"Maximum": {
"properties": {
"maximum_amount": {
"type": "string",
"title": "Maximum Amount",
"description": "Maximum amount applied"
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this maximum to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "List of price_ids that this maximum amount applies to. For plan/plan phase maximums, this can be a subset of prices.",
"deprecated": true
}
},
"type": "object",
"required": [
"maximum_amount",
"filters",
"applies_to_price_ids"
],
"title": "Maximum"
},
"MaximumInterval": {
"properties": {
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the maximum interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the maximum interval."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices this maximum interval applies to."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval ids that this maximum interval applies to."
},
"maximum_amount": {
"type": "string",
"title": "Maximum Amount",
"description": "The maximum amount to charge in a given billing period for the price intervals this transform applies to."
}
},
"type": "object",
"required": [
"start_date",
"end_date",
"filters",
"applies_to_price_interval_ids",
"maximum_amount"
],
"title": "MaximumInterval"
},
"MeteredAllowanceConfig": {
"properties": {
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "Event property used to partition the metric into consumption and allowance quantities (e.g. 'event_name'). The metric is queried with this key and the two values below select which partition is which."
},
"consumption_grouping_value": {
"type": "string",
"minLength": 1,
"title": "Consumption Grouping Value",
"description": "The grouping_key value whose summed quantity represents consumption (e.g. 'download'). Charged at unit_amount."
},
"allowance_grouping_value": {
"type": "string",
"minLength": 1,
"title": "Allowance Grouping Value",
"description": "The grouping_key value whose summed quantity represents the allowance for this period (e.g. 'storage_snapshot' emitting 3 \u00d7 avg storage). Capped at consumption \u2014 credit can never exceed actual usage."
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per-unit price applied to gross consumption and to the allowance credit."
},
"consumption_display_name": {
"type": "string",
"minLength": 1,
"title": "Consumption Display Name",
"description": "Sub-line label for the gross consumption row (e.g. 'bytes gotten').",
"default": "Consumption"
},
"allowance_display_name": {
"type": "string",
"minLength": 1,
"title": "Allowance Display Name",
"description": "Sub-line label for the credit row (e.g. 'Up to 3x free egress').",
"default": "Allowance credit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"grouping_key",
"consumption_grouping_value",
"allowance_grouping_value",
"unit_amount"
],
"title": "MeteredAllowanceConfig",
"description": "Charges a per-unit rate on consumption above an allowance whose size is itself\nmetered from usage in the same period. Both quantities come from a single billable\nmetric, partitioned by `grouping_key`.\n\nThe line item shows two sub-lines under one parent: the gross consumption row and\na (negative) allowance credit row. The parent line equals the net charge, never\nnegative \u2014 so adjustments, tax, prepaid credits, and rev rec all behave like any\nother usage line.\n\nUse cases: free egress proportional to bytes stored; free outbound bandwidth\nproportional to compute hours; free messages proportional to seat count; free\noutput tokens proportional to input tokens."
},
"MeteredAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"metered_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"metered_allowance_config": {
"$ref": "#/components/schemas/MeteredAllowanceConfig",
"description": "Configuration for metered_allowance pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"metered_allowance_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MeteredAllowancePrice"
},
"MetricGroup": {
"properties": {
"property_key": {
"type": "string",
"title": "Property Key"
},
"property_value": {
"type": "string",
"title": "Property Value"
}
},
"type": "object",
"required": [
"property_key",
"property_value"
],
"title": "MetricGroup"
},
"Minimum": {
"properties": {
"minimum_amount": {
"type": "string",
"title": "Minimum Amount",
"description": "Minimum amount applied"
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this minimum to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "List of price_ids that this minimum amount applies to. For plan/plan phase minimums, this can be a subset of prices.",
"deprecated": true
}
},
"type": "object",
"required": [
"minimum_amount",
"filters",
"applies_to_price_ids"
],
"title": "Minimum"
},
"MinimumCompositeConfig": {
"properties": {
"minimum_amount": {
"type": "string",
"title": "Minimum Amount",
"description": "The minimum amount to apply"
},
"prorated": {
"type": "boolean",
"title": "Prorated",
"description": "If true, subtotals from this price are prorated based on the service period"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"minimum_amount"
],
"title": "MinimumCompositeConfig",
"description": "Configuration for minimum composite price"
},
"MinimumCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"minimum_composite"
],
"title": "Model Type",
"description": "The pricing model type"
},
"minimum_composite_config": {
"$ref": "#/components/schemas/MinimumCompositeConfig",
"description": "Configuration for minimum_composite pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"minimum_composite_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "MinimumCompositePrice"
},
"MinimumInterval": {
"properties": {
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the minimum interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the minimum interval."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices this minimum interval applies to."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval ids that this minimum interval applies to."
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount",
"description": "The minimum amount to charge in a given billing period for the price intervals this minimum applies to."
}
},
"type": "object",
"required": [
"start_date",
"end_date",
"filters",
"applies_to_price_interval_ids",
"minimum_amount"
],
"title": "MinimumInterval"
},
"MonetaryAdjustment": {
"oneOf": [
{
"$ref": "#/components/schemas/MonetaryUsageDiscountAdjustment"
},
{
"$ref": "#/components/schemas/MonetaryAmountDiscountAdjustment"
},
{
"$ref": "#/components/schemas/MonetaryPercentageDiscountAdjustment"
},
{
"$ref": "#/components/schemas/MonetaryMinimumAdjustment"
},
{
"$ref": "#/components/schemas/MonetaryMaximumAdjustment"
}
],
"discriminator": {
"propertyName": "adjustment_type",
"mapping": {
"amount_discount": "#/components/schemas/MonetaryAmountDiscountAdjustment",
"maximum": "#/components/schemas/MonetaryMaximumAdjustment",
"minimum": "#/components/schemas/MonetaryMinimumAdjustment",
"percentage_discount": "#/components/schemas/MonetaryPercentageDiscountAdjustment",
"usage_discount": "#/components/schemas/MonetaryUsageDiscountAdjustment"
}
}
},
"MonetaryAmountDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"amount_discount"
],
"title": "Adjustment Type"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount",
"description": "The amount by which to discount the prices this adjustment applies to in a given billing period."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value applied by an adjustment."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"amount_discount",
"amount"
],
"title": "MonetaryAmountDiscountAdjustment"
},
"MonetaryMaximumAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"maximum"
],
"title": "Adjustment Type"
},
"maximum_amount": {
"type": "string",
"title": "Maximum Amount",
"description": "The maximum amount to charge in a given billing period for the prices this adjustment applies to."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value applied by an adjustment."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"maximum_amount",
"amount"
],
"title": "MonetaryMaximumAdjustment"
},
"MonetaryMinimumAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"minimum"
],
"title": "Adjustment Type"
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount",
"description": "The minimum amount to charge in a given billing period for the prices this adjustment applies to."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The item ID that revenue from this minimum will be attributed to."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value applied by an adjustment."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"minimum_amount",
"item_id",
"amount"
],
"title": "MonetaryMinimumAdjustment"
},
"MonetaryPercentageDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"percentage_discount"
],
"title": "Adjustment Type"
},
"percentage_discount": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Percentage Discount",
"description": "The percentage (as a value between 0 and 1) by which to discount the price intervals this adjustment applies to in a given billing period."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value applied by an adjustment."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"percentage_discount",
"amount"
],
"title": "MonetaryPercentageDiscountAdjustment"
},
"MonetaryUsageDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"usage_discount"
],
"title": "Adjustment Type"
},
"usage_discount": {
"type": "number",
"title": "Usage Discount",
"description": "The number of usage units by which to discount the price this adjustment applies to in a given billing period."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The value applied by an adjustment."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"usage_discount",
"amount"
],
"title": "MonetaryUsageDiscountAdjustment"
},
"MutatedSubscription": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"customer": {
"$ref": "#/components/schemas/Customer"
},
"plan": {
"oneOf": [
{
"$ref": "#/components/schemas/Plan"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the subscription."
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The date Orb starts billing for this subscription."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The date Orb stops billing for this subscription."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"current_billing_period_start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period Start Date",
"description": "The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active."
},
"current_billing_period_end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period End Date",
"description": "The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active."
},
"status": {
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
],
"title": "Status"
},
"trial_info": {
"$ref": "#/components/schemas/SubscriptionTrialInfo"
},
"active_plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Active Plan Phase Order",
"description": "The current plan phase that is active, only if the subscription's plan has phases."
},
"fixed_fee_quantity_schedule": {
"items": {
"$ref": "#/components/schemas/FixedFeeQuantityScheduleEntry"
},
"type": "array",
"title": "Fixed Fee Quantity Schedule"
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior. If null, defaults to the customer's setting."
},
"net_terms": {
"type": "integer",
"title": "Net Terms",
"description": "Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of `0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice."
},
"redeemed_coupon": {
"oneOf": [
{
"$ref": "#/components/schemas/CouponRedemption"
},
{
"type": "null"
}
]
},
"billing_cycle_day": {
"type": "integer",
"maximum": 31.0,
"minimum": 1.0,
"title": "Billing Cycle Day",
"description": "The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th."
},
"billing_cycle_anchor_configuration": {
"$ref": "#/components/schemas/BillingCycleAnchorConfiguration"
},
"invoicing_threshold": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoicing Threshold"
},
"price_intervals": {
"items": {
"$ref": "#/components/schemas/PriceInterval"
},
"type": "array",
"title": "Price Intervals",
"description": "The price intervals for this subscription."
},
"adjustment_intervals": {
"items": {
"$ref": "#/components/schemas/AdjustmentInterval"
},
"type": "array",
"title": "Adjustment Intervals",
"description": "The adjustment intervals for this subscription sorted by the start_date of the adjustment interval."
},
"discount_intervals": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AmountDiscountInterval"
},
{
"$ref": "#/components/schemas/PercentageDiscountInterval"
},
{
"$ref": "#/components/schemas/UsageDiscountInterval"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscountInterval",
"percentage": "#/components/schemas/PercentageDiscountInterval",
"usage": "#/components/schemas/UsageDiscountInterval"
}
}
},
"type": "array",
"title": "Discount Intervals",
"description": "The discount intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"minimum_intervals": {
"items": {
"$ref": "#/components/schemas/MinimumInterval"
},
"type": "array",
"title": "Minimum Intervals",
"description": "The minimum intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"maximum_intervals": {
"items": {
"$ref": "#/components/schemas/MaximumInterval"
},
"type": "array",
"title": "Maximum Intervals",
"description": "The maximum intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"pending_subscription_change": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionChangeMinified"
},
{
"type": "null"
}
],
"description": "A pending subscription change if one exists on this subscription."
},
"changed_resources": {
"oneOf": [
{
"$ref": "#/components/schemas/ChangedSubscriptionResources"
},
{
"type": "null"
}
],
"description": "The resources that were changed as part of this operation. Only present when fetched through the subscription changes API or if the `include_changed_resources` parameter was passed in the request."
}
},
"type": "object",
"required": [
"metadata",
"id",
"customer",
"plan",
"name",
"start_date",
"end_date",
"created_at",
"current_billing_period_start_date",
"current_billing_period_end_date",
"status",
"trial_info",
"active_plan_phase_order",
"fixed_fee_quantity_schedule",
"default_invoice_memo",
"auto_collection",
"net_terms",
"redeemed_coupon",
"billing_cycle_day",
"billing_cycle_anchor_configuration",
"invoicing_threshold",
"price_intervals",
"adjustment_intervals",
"discount_intervals",
"minimum_intervals",
"maximum_intervals",
"pending_subscription_change"
],
"title": "MutatedSubscription"
},
"NewAccountingSyncConfiguration": {
"properties": {
"excluded": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Excluded"
},
"accounting_providers": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AccountingProviderConfig"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Accounting Providers"
}
},
"type": "object",
"title": "NewAccountingSyncConfiguration"
},
"NewAdjustment": {
"oneOf": [
{
"$ref": "#/components/schemas/NewPercentageDiscount"
},
{
"$ref": "#/components/schemas/NewUsageDiscount"
},
{
"$ref": "#/components/schemas/NewAmountDiscount"
},
{
"$ref": "#/components/schemas/NewMinimum"
},
{
"$ref": "#/components/schemas/NewMaximum"
}
],
"discriminator": {
"propertyName": "adjustment_type",
"mapping": {
"amount_discount": "#/components/schemas/NewAmountDiscount",
"maximum": "#/components/schemas/NewMaximum",
"minimum": "#/components/schemas/NewMinimum",
"percentage_discount": "#/components/schemas/NewPercentageDiscount",
"usage_discount": "#/components/schemas/NewUsageDiscount"
}
}
},
"NewAllocationPrice": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or a custom pricing unit identifier in which to bill this price.",
"examples": [
"USD",
"credits"
]
},
"amount": {
"type": "string",
"title": "Amount",
"description": "An amount of the currency to allocate to the customer at the specified cadence.",
"examples": [
"10.00",
"5"
]
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual"
],
"title": "Cadence",
"description": "The cadence at which to allocate the amount to the customer.",
"examples": [
"monthly",
"quarterly"
]
},
"expires_at_end_of_cadence": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Expires At End Of Cadence",
"description": "Whether the allocated amount should expire at the end of the cadence or roll over to the next period. Set to null if using custom_expiration."
},
"custom_expiration": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomExpiration"
},
{
"type": "null"
}
],
"description": "The custom expiration for the allocation."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/BlockPriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "The filters that determine which items the allocation applies to."
},
"per_unit_cost_basis": {
"type": "string",
"title": "Per Unit Cost Basis",
"description": "The (per-unit) cost basis of each created block. If non-zero, a customer will be invoiced according to the quantity and per unit cost basis specified for the allocation each cadence.",
"default": "0.00"
},
"item_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Item Id",
"description": "The item ID that line items representing charges for this allocation will be associated with. If not provided, the default allocation item for the currency will be used (e.g. 'Included Allocation (USD)')."
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The license type ID to associate the price with license allocation. "
}
},
"type": "object",
"required": [
"currency",
"amount",
"cadence"
],
"title": "NewAllocationPrice"
},
"NewAmountDiscount": {
"properties": {
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "The set of price IDs to which this adjustment applies.",
"examples": [
[
"price_1",
"price_2"
]
]
},
"applies_to_item_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Item Ids",
"description": "The set of item IDs to which this adjustment applies.",
"examples": [
[
"item_1",
"item_2"
]
]
},
"applies_to_all": {
"oneOf": [
{
"type": "boolean",
"enum": [
true
]
},
{
"type": "null"
}
],
"title": "Applies To All",
"description": "If set, the adjustment will apply to every price on the subscription."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "A list of filters that determine which prices this adjustment will apply to."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "If set, only prices in the specified currency will have the adjustment applied.",
"examples": [
[
"USD",
"JPY",
"credits"
]
]
},
"price_type": {
"oneOf": [
{
"type": "string",
"enum": [
"usage",
"fixed_in_advance",
"fixed_in_arrears",
"fixed",
"in_arrears"
]
},
{
"type": "null"
}
],
"title": "Price Type",
"description": "If set, only prices of the specified type will have the adjustment applied."
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.",
"default": true
},
"adjustment_type": {
"type": "string",
"enum": [
"amount_discount"
],
"title": "Adjustment Type"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount"
}
},
"type": "object",
"required": [
"adjustment_type",
"amount_discount"
],
"title": "NewAmountDiscount"
},
"NewAnrokConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"anrok"
],
"title": "Tax Provider"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewAnrokConfiguration"
},
"NewAvalaraTaxConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"avalara"
],
"title": "Tax Provider"
},
"tax_exemption_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tax Exemption Code"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewAvalaraTaxConfiguration"
},
"NewBackfill": {
"properties": {
"replace_existing_events": {
"type": "boolean",
"title": "Replace Existing Events",
"description": "If true, replaces all existing events in the timeframe with the newly ingested events. If false, adds the newly ingested events to the existing events.",
"default": true
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start",
"description": "The (inclusive) start of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case."
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End",
"description": "The (exclusive) end of the usage timeframe affected by this backfill. By default, Orb allows backfills up to 31 days in duration at a time. Reach out to discuss extending this limit and your use case."
},
"close_time": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Close Time",
"description": "The time at which no more events will be accepted for this backfill. The backfill will automatically begin reflecting throughout Orb at the close time. If not specified, it will default to 1 day after the creation of the backfill."
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb-generated ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers."
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "The external customer ID of the customer to which this backfill is scoped. Omitting this field will scope the backfill to all customers."
},
"deprecation_filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Deprecation Filter",
"description": "A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the set of events to deprecate",
"examples": [
"my_numeric_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"timeframe_start",
"timeframe_end"
],
"title": "NewBackfill"
},
"NewBillableMetric": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"sql": {
"type": "string",
"title": "Sql",
"description": "A sql string defining the metric.",
"examples": [
"SELECT sum(bytes_downloaded) FROM events WHERE download_speed = 'fast'"
]
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the metric.",
"examples": [
"Bytes downloaded"
]
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "A description of the metric.",
"examples": [
"Sum of bytes downloaded in fast mode"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"sql",
"name",
"item_id",
"description"
],
"title": "NewBillableMetric"
},
"NewBillingCycleConfiguration": {
"properties": {
"duration": {
"type": "integer",
"title": "Duration",
"description": "The duration of the billing period."
},
"duration_unit": {
"type": "string",
"enum": [
"day",
"month"
],
"title": "Duration Unit",
"description": "The unit of billing period duration."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"duration",
"duration_unit"
],
"title": "NewBillingCycleConfiguration"
},
"NewCoupon": {
"properties": {
"redemption_code": {
"type": "string",
"title": "Redemption Code",
"description": "This string can be used to redeem this coupon for a given subscription.",
"examples": [
"HALFOFF"
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/NewCouponPercentageDiscount"
},
{
"$ref": "#/components/schemas/NewCouponAmountDiscount"
}
],
"title": "Discount",
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/NewCouponAmountDiscount",
"percentage": "#/components/schemas/NewCouponPercentageDiscount"
}
}
},
"duration_in_months": {
"oneOf": [
{
"type": "integer",
"maximum": 120.0,
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Duration In Months",
"description": "This allows for a coupon's discount to apply for a limited time (determined in months); a `null` value here means \"unlimited time\".",
"examples": [
12
]
},
"max_redemptions": {
"oneOf": [
{
"type": "integer",
"maximum": 1000000000.0,
"minimum": 1.0
},
{
"type": "null"
}
],
"title": "Max Redemptions",
"description": "The maximum number of redemptions allowed for this coupon before it is exhausted;`null` here means \"unlimited\"."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"redemption_code",
"discount"
],
"title": "NewCoupon"
},
"NewCouponAmountDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"amount"
],
"title": "Discount Type"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount"
}
},
"type": "object",
"required": [
"discount_type",
"amount_discount"
],
"title": "NewCouponAmountDiscount"
},
"NewCouponPercentageDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage"
],
"title": "Discount Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount",
"ge": 0,
"le": 1
}
},
"type": "object",
"required": [
"discount_type",
"percentage_discount"
],
"title": "NewCouponPercentageDiscount"
},
"NewCustomer": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"type": "string",
"maxLength": 500,
"minLength": 1,
"title": "Name",
"description": "The full name of the customer"
},
"email": {
"type": "string",
"maxLength": 500,
"format": "email",
"title": "Email",
"description": "A valid customer email, to be used for notifications. When Orb triggers payment through a payment gateway, this email will be used for any automatically issued receipts."
},
"timezone": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Timezone",
"description": "A timezone identifier from the IANA timezone database, such as `\"America/Los_Angeles\"`. This defaults to your account's timezone if not set. This cannot be changed after customer creation."
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An optional user-defined ID for this customer resource, used throughout the system as an alias for this Customer. Use this field to identify a customer by an existing identifier in your system."
},
"payment_provider_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Provider Id",
"description": "The ID of this customer in an external payments solution, such as Stripe. This is used for creating charges or invoices in the external system via Orb."
},
"payment_provider": {
"oneOf": [
{
"type": "string",
"enum": [
"quickbooks",
"bill.com",
"stripe_charge",
"stripe_invoice",
"netsuite"
]
},
{
"type": "null"
}
],
"title": "Payment Provider",
"description": "This is used for creating charges or invoices in an external system via Orb. When not in test mode, the connection must first be configured in the Orb webapp."
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressInput"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/AddressInput"
},
{
"type": "null"
}
]
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string used for the customer's invoices and balance. If not set at creation time, will be set at subscription creation time."
},
"tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Used to determine if invoices for this customer will automatically attempt to charge a saved payment method, if available. This parameter defaults to `True` when a payment provider is provided on customer creation."
},
"auto_issuance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Issuance",
"description": "Used to determine if invoices for this customer will be automatically issued. If true, invoices will be automatically issued. If false, invoices will require manual approval. If `null` is specified, the customer's auto issuance setting will be inherited from the account-level setting."
},
"email_delivery": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Email Delivery"
},
"tax_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewTaxConfiguration"
},
{
"type": "null"
}
]
},
"reporting_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewReportingConfiguration"
},
{
"type": "null"
}
]
},
"accounting_sync_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAccountingSyncConfiguration"
},
{
"type": "null"
}
]
},
"additional_emails": {
"oneOf": [
{
"items": {
"type": "string",
"format": "email"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Additional Emails",
"description": "Additional email addresses for this customer. If populated, these email addresses will be CC'd for customer communications. The total number of email addresses (including the primary email) cannot exceed 50."
},
"hierarchy": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerHierarchyConfig"
},
{
"type": "null"
}
],
"description": "The hierarchical relationships for this customer."
},
"payment_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/PaymentConfiguration"
},
{
"type": "null"
}
],
"description": "Payment configuration for the customer, applicable when using Orb Invoicing with a supported payment provider such as Stripe."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"email"
],
"title": "NewCustomer"
},
"NewCustomerBalanceTransaction": {
"properties": {
"amount": {
"type": "string",
"title": "Amount"
},
"type": {
"type": "string",
"enum": [
"increment",
"decrement"
],
"title": "Type"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional description that can be specified around this entry."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"amount",
"type"
],
"title": "NewCustomerBalanceTransaction"
},
"NewDimensionalPriceConfiguration": {
"properties": {
"dimensional_price_group_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Dimensional Price Group Id",
"description": "The id of the dimensional price group to include this price in"
},
"external_dimensional_price_group_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Dimensional Price Group Id",
"description": "The external id of the dimensional price group to include this price in"
},
"dimension_values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Dimension Values",
"description": "The list of dimension values matching (in order) the dimensions of the price group"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"dimension_values"
],
"title": "NewDimensionalPriceConfiguration"
},
"NewDimensionalPriceGroup": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"type": "string",
"title": "Name"
},
"external_dimensional_price_group_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Dimensional Price Group Id"
},
"dimensions": {
"items": {
"type": "string"
},
"type": "array",
"minItems": 1,
"uniqueItems": true,
"title": "Dimensions",
"description": "The set of keys (in order) used to disambiguate prices in the group.",
"examples": [
[
"region",
"instance_type"
]
]
},
"billable_metric_id": {
"type": "string",
"title": "Billable Metric Id"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"dimensions",
"billable_metric_id"
],
"title": "NewDimensionalPriceGroup"
},
"NewFloatingBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_config": {
"$ref": "#/components/schemas/BulkConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingBulkPrice"
},
"NewFloatingBulkWithFiltersPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_filters"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_filters_config": {
"$ref": "#/components/schemas/BulkWithFiltersConfig",
"description": "Configuration for bulk_with_filters pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_filters_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingBulkWithFiltersPrice"
},
"NewFloatingBulkWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_proration_config": {
"$ref": "#/components/schemas/BulkWithProrationConfig",
"description": "Configuration for bulk_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_proration_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingBulkWithProrationPrice"
},
"NewFloatingCumulativeGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_allocation_config": {
"$ref": "#/components/schemas/CumulativeGroupedAllocationConfig",
"description": "Configuration for cumulative_grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_allocation_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingCumulativeGroupedAllocationPrice"
},
"NewFloatingCumulativeGroupedBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_bulk_config": {
"$ref": "#/components/schemas/CumulativeGroupedBulkConfig",
"description": "Configuration for cumulative_grouped_bulk pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_bulk_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingCumulativeGroupedBulkPrice"
},
"NewFloatingDailyCreditAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"daily_credit_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"daily_credit_allowance_config": {
"$ref": "#/components/schemas/DailyCreditAllowanceConfig",
"description": "Configuration for daily_credit_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"daily_credit_allowance_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingDailyCreditAllowancePrice"
},
"NewFloatingEventOutputPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"event_output"
],
"title": "Model Type",
"description": "The pricing model type"
},
"event_output_config": {
"$ref": "#/components/schemas/EventOutputConfig",
"description": "Configuration for event_output pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"event_output_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingEventOutputPrice"
},
"NewFloatingGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_allocation_config": {
"$ref": "#/components/schemas/GroupedAllocationConfig",
"description": "Configuration for grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_allocation_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedAllocationPrice"
},
"NewFloatingGroupedTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_package_config": {
"$ref": "#/components/schemas/GroupedTieredPackagePricingConfig",
"description": "Configuration for grouped_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_package_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedTieredPackagePrice"
},
"NewFloatingGroupedTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_config": {
"$ref": "#/components/schemas/GroupedTieredConfig",
"description": "Configuration for grouped_tiered pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedTieredPrice"
},
"NewFloatingGroupedWithMeteredMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_metered_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_metered_minimum_config": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumConfig",
"description": "Configuration for grouped_with_metered_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_metered_minimum_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedWithMeteredMinimumPrice"
},
"NewFloatingGroupedWithMinMaxThresholdsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_min_max_thresholds"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_min_max_thresholds_config": {
"$ref": "#/components/schemas/GroupedWithMinMaxThresholdsConfig",
"description": "Configuration for grouped_with_min_max_thresholds pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_min_max_thresholds_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedWithMinMaxThresholdsPrice"
},
"NewFloatingGroupedWithProratedMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_prorated_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_prorated_minimum_config": {
"$ref": "#/components/schemas/GroupedWithProratedMinimumConfig",
"description": "Configuration for grouped_with_prorated_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_prorated_minimum_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingGroupedWithProratedMinimumPrice"
},
"NewFloatingMatrixPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_config": {
"$ref": "#/components/schemas/MatrixConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMatrixPrice"
},
"NewFloatingMatrixWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_allocation_config": {
"$ref": "#/components/schemas/MatrixWithAllocationConfig",
"description": "Configuration for matrix_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_allocation_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMatrixWithAllocationPrice"
},
"NewFloatingMatrixWithDisplayNamePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_display_name"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_display_name_config": {
"$ref": "#/components/schemas/MatrixWithDisplayNameConfig",
"description": "Configuration for matrix_with_display_name pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_display_name_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMatrixWithDisplayNamePrice"
},
"NewFloatingMatrixWithThresholdDiscountsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_threshold_discounts"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_threshold_discounts_config": {
"$ref": "#/components/schemas/MatrixWithThresholdDiscountsConfig",
"description": "Configuration for matrix_with_threshold_discounts pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_threshold_discounts_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMatrixWithThresholdDiscountsPrice"
},
"NewFloatingMaxGroupTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"max_group_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"max_group_tiered_package_config": {
"$ref": "#/components/schemas/MaxGroupTieredPackageConfig",
"description": "Configuration for max_group_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"max_group_tiered_package_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMaxGroupTieredPackagePrice"
},
"NewFloatingMeteredAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"metered_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"metered_allowance_config": {
"$ref": "#/components/schemas/MeteredAllowanceConfig",
"description": "Configuration for metered_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"metered_allowance_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMeteredAllowancePrice"
},
"NewFloatingMinimumCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"minimum_composite"
],
"title": "Model Type",
"description": "The pricing model type"
},
"minimum_composite_config": {
"$ref": "#/components/schemas/MinimumCompositeConfig",
"description": "Configuration for minimum_composite pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"minimum_composite_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingMinimumCompositePrice"
},
"NewFloatingPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_config": {
"$ref": "#/components/schemas/PackageConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingPackagePrice"
},
"NewFloatingPackageWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_with_allocation_config": {
"$ref": "#/components/schemas/PackageWithAllocationConfig",
"description": "Configuration for package_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_with_allocation_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingPackageWithAllocationPrice"
},
"NewFloatingPercentCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"percent_config": {
"$ref": "#/components/schemas/PercentCompositeConfig",
"description": "Configuration for percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"percent_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingPercentCompositePrice"
},
"NewFloatingPrice": {
"oneOf": [
{
"$ref": "#/components/schemas/NewFloatingUnitPrice"
},
{
"$ref": "#/components/schemas/NewFloatingTieredPrice"
},
{
"$ref": "#/components/schemas/NewFloatingBulkPrice"
},
{
"$ref": "#/components/schemas/NewFloatingBulkWithFiltersPrice"
},
{
"$ref": "#/components/schemas/NewFloatingPackagePrice"
},
{
"$ref": "#/components/schemas/NewFloatingMatrixPrice"
},
{
"$ref": "#/components/schemas/NewFloatingThresholdTotalAmountPrice"
},
{
"$ref": "#/components/schemas/NewFloatingTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewFloatingTieredWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedTieredPrice"
},
{
"$ref": "#/components/schemas/NewFloatingTieredPackageWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewFloatingPackageWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingUnitWithPercentPrice"
},
{
"$ref": "#/components/schemas/NewFloatingMatrixWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingMatrixWithThresholdDiscountsPrice"
},
{
"$ref": "#/components/schemas/NewFloatingTieredWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingUnitWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingBulkWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedWithProratedMinimumPrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedWithMeteredMinimumPrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedWithMinMaxThresholdsPrice"
},
{
"$ref": "#/components/schemas/NewFloatingMatrixWithDisplayNamePrice"
},
{
"$ref": "#/components/schemas/NewFloatingGroupedTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewFloatingMaxGroupTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewFloatingScalableMatrixWithUnitPricingPrice"
},
{
"$ref": "#/components/schemas/NewFloatingScalableMatrixWithTieredPricingPrice"
},
{
"$ref": "#/components/schemas/NewFloatingCumulativeGroupedBulkPrice"
},
{
"$ref": "#/components/schemas/NewFloatingCumulativeGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewFloatingDailyCreditAllowancePrice"
},
{
"$ref": "#/components/schemas/NewFloatingMeteredAllowancePrice"
},
{
"$ref": "#/components/schemas/NewFloatingMinimumCompositePrice"
},
{
"$ref": "#/components/schemas/NewFloatingPercentCompositePrice"
},
{
"$ref": "#/components/schemas/NewFloatingEventOutputPrice"
}
],
"description": "New floating price request body params.",
"discriminator": {
"propertyName": "model_type",
"mapping": {
"bulk": "#/components/schemas/NewFloatingBulkPrice",
"bulk_with_filters": "#/components/schemas/NewFloatingBulkWithFiltersPrice",
"bulk_with_proration": "#/components/schemas/NewFloatingBulkWithProrationPrice",
"cumulative_grouped_allocation": "#/components/schemas/NewFloatingCumulativeGroupedAllocationPrice",
"cumulative_grouped_bulk": "#/components/schemas/NewFloatingCumulativeGroupedBulkPrice",
"daily_credit_allowance": "#/components/schemas/NewFloatingDailyCreditAllowancePrice",
"event_output": "#/components/schemas/NewFloatingEventOutputPrice",
"grouped_allocation": "#/components/schemas/NewFloatingGroupedAllocationPrice",
"grouped_tiered": "#/components/schemas/NewFloatingGroupedTieredPrice",
"grouped_tiered_package": "#/components/schemas/NewFloatingGroupedTieredPackagePrice",
"grouped_with_metered_minimum": "#/components/schemas/NewFloatingGroupedWithMeteredMinimumPrice",
"grouped_with_min_max_thresholds": "#/components/schemas/NewFloatingGroupedWithMinMaxThresholdsPrice",
"grouped_with_prorated_minimum": "#/components/schemas/NewFloatingGroupedWithProratedMinimumPrice",
"matrix": "#/components/schemas/NewFloatingMatrixPrice",
"matrix_with_allocation": "#/components/schemas/NewFloatingMatrixWithAllocationPrice",
"matrix_with_display_name": "#/components/schemas/NewFloatingMatrixWithDisplayNamePrice",
"matrix_with_threshold_discounts": "#/components/schemas/NewFloatingMatrixWithThresholdDiscountsPrice",
"max_group_tiered_package": "#/components/schemas/NewFloatingMaxGroupTieredPackagePrice",
"metered_allowance": "#/components/schemas/NewFloatingMeteredAllowancePrice",
"minimum_composite": "#/components/schemas/NewFloatingMinimumCompositePrice",
"package": "#/components/schemas/NewFloatingPackagePrice",
"package_with_allocation": "#/components/schemas/NewFloatingPackageWithAllocationPrice",
"percent": "#/components/schemas/NewFloatingPercentCompositePrice",
"scalable_matrix_with_tiered_pricing": "#/components/schemas/NewFloatingScalableMatrixWithTieredPricingPrice",
"scalable_matrix_with_unit_pricing": "#/components/schemas/NewFloatingScalableMatrixWithUnitPricingPrice",
"threshold_total_amount": "#/components/schemas/NewFloatingThresholdTotalAmountPrice",
"tiered": "#/components/schemas/NewFloatingTieredPrice",
"tiered_package": "#/components/schemas/NewFloatingTieredPackagePrice",
"tiered_package_with_minimum": "#/components/schemas/NewFloatingTieredPackageWithMinimumPrice",
"tiered_with_minimum": "#/components/schemas/NewFloatingTieredWithMinimumPrice",
"tiered_with_proration": "#/components/schemas/NewFloatingTieredWithProrationPrice",
"unit": "#/components/schemas/NewFloatingUnitPrice",
"unit_with_percent": "#/components/schemas/NewFloatingUnitWithPercentPrice",
"unit_with_proration": "#/components/schemas/NewFloatingUnitWithProrationPrice"
}
}
},
"NewFloatingScalableMatrixWithTieredPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_tiered_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_tiered_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredPricingConfig",
"description": "Configuration for scalable_matrix_with_tiered_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_tiered_pricing_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingScalableMatrixWithTieredPricingPrice"
},
"NewFloatingScalableMatrixWithUnitPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_unit_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_unit_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithUnitPricingConfig",
"description": "Configuration for scalable_matrix_with_unit_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_unit_pricing_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingScalableMatrixWithUnitPricingPrice"
},
"NewFloatingThresholdTotalAmountPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"threshold_total_amount"
],
"title": "Model Type",
"description": "The pricing model type"
},
"threshold_total_amount_config": {
"$ref": "#/components/schemas/ThresholdTotalAmountConfig",
"description": "Configuration for threshold_total_amount pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"threshold_total_amount_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingThresholdTotalAmountPrice"
},
"NewFloatingTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_config": {
"$ref": "#/components/schemas/TieredPackagePricingConfig",
"description": "Configuration for tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingTieredPackagePrice"
},
"NewFloatingTieredPackageWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_with_minimum_config": {
"$ref": "#/components/schemas/TieredPackagePricingWithMinimumConfig",
"description": "Configuration for tiered_package_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_with_minimum_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingTieredPackageWithMinimumPrice"
},
"NewFloatingTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_config": {
"$ref": "#/components/schemas/TieredConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingTieredPrice"
},
"NewFloatingTieredWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_minimum_config": {
"$ref": "#/components/schemas/TieredPricingWithMinimumConfig",
"description": "Configuration for tiered_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_minimum_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingTieredWithMinimumPrice"
},
"NewFloatingTieredWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_proration_config": {
"$ref": "#/components/schemas/TieredWithProrationConfig",
"description": "Configuration for tiered_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_proration_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingTieredWithProrationPrice"
},
"NewFloatingUnitPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingUnitPrice"
},
"NewFloatingUnitWithPercentPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_percent_config": {
"$ref": "#/components/schemas/UnitWithPercentConfig",
"description": "Configuration for unit_with_percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_percent_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingUnitWithPercentPrice"
},
"NewFloatingUnitWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_proration_config": {
"$ref": "#/components/schemas/UnitWithProrationConfig",
"description": "Configuration for unit_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for which this price is billed in."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_proration_config",
"name",
"item_id",
"cadence",
"currency"
],
"title": "NewFloatingUnitWithProrationPrice"
},
"NewItem": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the item.",
"examples": [
"API requests"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name"
],
"title": "NewItem"
},
"NewLicense": {
"properties": {
"subscription_id": {
"type": "string",
"title": "Subscription Id"
},
"license_type_id": {
"type": "string",
"title": "License Type Id"
},
"external_license_id": {
"type": "string",
"title": "External License Id",
"description": "The external identifier for the license."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Start Date",
"description": "The start date of the license. If not provided, defaults to start of day today in the customer's timezone.",
"examples": [
"2026-01-27"
]
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the license. If not provided, the license will remain active until deactivated.",
"examples": [
"2026-01-27"
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"subscription_id",
"license_type_id",
"external_license_id"
],
"title": "NewLicense"
},
"NewLicenseAllocation": {
"properties": {
"currency": {
"type": "string",
"title": "Currency",
"description": "The currency of the license allocation."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount of credits granted per active license per cadence."
},
"write_off_overage": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Write Off Overage",
"description": "When True, overage beyond the allocation is written off."
}
},
"type": "object",
"required": [
"currency",
"amount"
],
"title": "NewLicenseAllocation"
},
"NewLicenseAllocationPrice": {
"oneOf": [
{
"$ref": "#/components/schemas/NewLicenseAllocationUnitPrice"
}
],
"discriminator": {
"propertyName": "model_type",
"mapping": {
"unit": "#/components/schemas/NewLicenseAllocationUnitPrice"
}
}
},
"NewLicenseAllocationUnitPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
},
"license_allocations": {
"items": {
"$ref": "#/components/schemas/NewLicenseAllocation"
},
"type": "array",
"title": "License Allocations",
"description": "License allocations to associate with this price. Each entry defines a per-license credit pool granted each cadence. Requires license_type_id or license_type_configuration to be set."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_config",
"name",
"item_id",
"cadence",
"license_allocations"
],
"title": "NewLicenseAllocationUnitPrice"
},
"NewLicenseType": {
"properties": {
"name": {
"type": "string",
"minLength": 1,
"title": "Name",
"description": "The name of the license type."
},
"grouping_key": {
"type": "string",
"minLength": 1,
"title": "Grouping Key",
"description": "The key used for grouping licenses of this type. This is typically a user identifier field."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"grouping_key"
],
"title": "NewLicenseType"
},
"NewLicenseTypeConfiguration": {
"properties": {
"license_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "License Grouping Key",
"description": "The property used to group this price for licensing"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type associated with this price."
}
},
"additionalProperties": false,
"type": "object",
"title": "NewLicenseTypeConfiguration"
},
"NewMaximum": {
"properties": {
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "The set of price IDs to which this adjustment applies.",
"examples": [
[
"price_1",
"price_2"
]
]
},
"applies_to_item_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Item Ids",
"description": "The set of item IDs to which this adjustment applies.",
"examples": [
[
"item_1",
"item_2"
]
]
},
"applies_to_all": {
"oneOf": [
{
"type": "boolean",
"enum": [
true
]
},
{
"type": "null"
}
],
"title": "Applies To All",
"description": "If set, the adjustment will apply to every price on the subscription."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "A list of filters that determine which prices this adjustment will apply to."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "If set, only prices in the specified currency will have the adjustment applied.",
"examples": [
[
"USD",
"JPY",
"credits"
]
]
},
"price_type": {
"oneOf": [
{
"type": "string",
"enum": [
"usage",
"fixed_in_advance",
"fixed_in_arrears",
"fixed",
"in_arrears"
]
},
{
"type": "null"
}
],
"title": "Price Type",
"description": "If set, only prices of the specified type will have the adjustment applied."
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.",
"default": true
},
"adjustment_type": {
"type": "string",
"enum": [
"maximum"
],
"title": "Adjustment Type"
},
"maximum_amount": {
"type": "string",
"title": "Maximum Amount"
}
},
"type": "object",
"required": [
"adjustment_type",
"maximum_amount"
],
"title": "NewMaximum"
},
"NewMinimum": {
"properties": {
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "The set of price IDs to which this adjustment applies.",
"examples": [
[
"price_1",
"price_2"
]
]
},
"applies_to_item_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Item Ids",
"description": "The set of item IDs to which this adjustment applies.",
"examples": [
[
"item_1",
"item_2"
]
]
},
"applies_to_all": {
"oneOf": [
{
"type": "boolean",
"enum": [
true
]
},
{
"type": "null"
}
],
"title": "Applies To All",
"description": "If set, the adjustment will apply to every price on the subscription."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "A list of filters that determine which prices this adjustment will apply to."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "If set, only prices in the specified currency will have the adjustment applied.",
"examples": [
[
"USD",
"JPY",
"credits"
]
]
},
"price_type": {
"oneOf": [
{
"type": "string",
"enum": [
"usage",
"fixed_in_advance",
"fixed_in_arrears",
"fixed",
"in_arrears"
]
},
{
"type": "null"
}
],
"title": "Price Type",
"description": "If set, only prices of the specified type will have the adjustment applied."
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.",
"default": true
},
"adjustment_type": {
"type": "string",
"enum": [
"minimum"
],
"title": "Adjustment Type"
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount"
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The item ID that revenue from this minimum will be attributed to."
}
},
"type": "object",
"required": [
"adjustment_type",
"minimum_amount",
"item_id"
],
"title": "NewMinimum"
},
"NewNumeralConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"numeral"
],
"title": "Tax Provider"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewNumeralConfiguration"
},
"NewPercentageDiscount": {
"properties": {
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "The set of price IDs to which this adjustment applies.",
"examples": [
[
"price_1",
"price_2"
]
]
},
"applies_to_item_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Item Ids",
"description": "The set of item IDs to which this adjustment applies.",
"examples": [
[
"item_1",
"item_2"
]
]
},
"applies_to_all": {
"oneOf": [
{
"type": "boolean",
"enum": [
true
]
},
{
"type": "null"
}
],
"title": "Applies To All",
"description": "If set, the adjustment will apply to every price on the subscription."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "A list of filters that determine which prices this adjustment will apply to."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "If set, only prices in the specified currency will have the adjustment applied.",
"examples": [
[
"USD",
"JPY",
"credits"
]
]
},
"price_type": {
"oneOf": [
{
"type": "string",
"enum": [
"usage",
"fixed_in_advance",
"fixed_in_arrears",
"fixed",
"in_arrears"
]
},
{
"type": "null"
}
],
"title": "Price Type",
"description": "If set, only prices of the specified type will have the adjustment applied."
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.",
"default": true
},
"adjustment_type": {
"type": "string",
"enum": [
"percentage_discount"
],
"title": "Adjustment Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount",
"ge": 0,
"le": 1
}
},
"type": "object",
"required": [
"adjustment_type",
"percentage_discount"
],
"title": "NewPercentageDiscount"
},
"NewPlan": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"description": "An optional user-defined description of the plan."
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Free-form text which is available on the invoice PDF and the Orb invoice portal."
},
"net_terms": {
"oneOf": [
{
"type": "integer",
"maximum": 365.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string for invoices generated by subscriptions on this plan."
},
"prices": {
"items": {
"$ref": "#/components/schemas/AddPlanPriceParams"
},
"type": "array",
"uniqueItems": true,
"title": "Prices",
"description": "Prices for this plan. If the plan has phases, this includes prices across all phases of the plan."
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id"
},
"status": {
"type": "string",
"enum": [
"active",
"draft"
],
"title": "Status",
"description": "The status of the plan to create (either active or draft). If not specified, this defaults to active.",
"default": "active"
},
"plan_phases": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/NewPlanPhase"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Plan Phases",
"description": "Configuration of pre-defined phases, each with their own prices and adjustments. Leave unspecified for plans with a single phase."
},
"adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddPlanAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Adjustments",
"description": "Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"name",
"currency",
"prices"
],
"title": "NewPlan"
},
"NewPlanBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_config": {
"$ref": "#/components/schemas/BulkConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanBulkPrice"
},
"NewPlanBulkWithFiltersPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_filters"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_filters_config": {
"$ref": "#/components/schemas/BulkWithFiltersConfig",
"description": "Configuration for bulk_with_filters pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_filters_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanBulkWithFiltersPrice"
},
"NewPlanBulkWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_proration_config": {
"$ref": "#/components/schemas/BulkWithProrationConfig",
"description": "Configuration for bulk_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanBulkWithProrationPrice"
},
"NewPlanCumulativeGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_allocation_config": {
"$ref": "#/components/schemas/CumulativeGroupedAllocationConfig",
"description": "Configuration for cumulative_grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanCumulativeGroupedAllocationPrice"
},
"NewPlanCumulativeGroupedBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_bulk_config": {
"$ref": "#/components/schemas/CumulativeGroupedBulkConfig",
"description": "Configuration for cumulative_grouped_bulk pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_bulk_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanCumulativeGroupedBulkPrice"
},
"NewPlanDailyCreditAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"daily_credit_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"daily_credit_allowance_config": {
"$ref": "#/components/schemas/DailyCreditAllowanceConfig",
"description": "Configuration for daily_credit_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"daily_credit_allowance_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanDailyCreditAllowancePrice"
},
"NewPlanEventOutputPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"event_output"
],
"title": "Model Type",
"description": "The pricing model type"
},
"event_output_config": {
"$ref": "#/components/schemas/EventOutputConfig",
"description": "Configuration for event_output pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"event_output_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanEventOutputPrice"
},
"NewPlanGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_allocation_config": {
"$ref": "#/components/schemas/GroupedAllocationConfig",
"description": "Configuration for grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedAllocationPrice"
},
"NewPlanGroupedTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_package_config": {
"$ref": "#/components/schemas/GroupedTieredPackagePricingConfig",
"description": "Configuration for grouped_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedTieredPackagePrice"
},
"NewPlanGroupedTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_config": {
"$ref": "#/components/schemas/GroupedTieredConfig",
"description": "Configuration for grouped_tiered pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedTieredPrice"
},
"NewPlanGroupedWithMeteredMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_metered_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_metered_minimum_config": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumConfig",
"description": "Configuration for grouped_with_metered_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_metered_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedWithMeteredMinimumPrice"
},
"NewPlanGroupedWithMinMaxThresholdsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_min_max_thresholds"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_min_max_thresholds_config": {
"$ref": "#/components/schemas/GroupedWithMinMaxThresholdsConfig",
"description": "Configuration for grouped_with_min_max_thresholds pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_min_max_thresholds_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedWithMinMaxThresholdsPrice"
},
"NewPlanGroupedWithProratedMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_prorated_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_prorated_minimum_config": {
"$ref": "#/components/schemas/GroupedWithProratedMinimumConfig",
"description": "Configuration for grouped_with_prorated_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_prorated_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanGroupedWithProratedMinimumPrice"
},
"NewPlanMatrixPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_config": {
"$ref": "#/components/schemas/MatrixConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMatrixPrice"
},
"NewPlanMatrixWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_allocation_config": {
"$ref": "#/components/schemas/MatrixWithAllocationConfig",
"description": "Configuration for matrix_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMatrixWithAllocationPrice"
},
"NewPlanMatrixWithDisplayNamePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_display_name"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_display_name_config": {
"$ref": "#/components/schemas/MatrixWithDisplayNameConfig",
"description": "Configuration for matrix_with_display_name pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_display_name_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMatrixWithDisplayNamePrice"
},
"NewPlanMatrixWithThresholdDiscountsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_threshold_discounts"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_threshold_discounts_config": {
"$ref": "#/components/schemas/MatrixWithThresholdDiscountsConfig",
"description": "Configuration for matrix_with_threshold_discounts pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_threshold_discounts_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMatrixWithThresholdDiscountsPrice"
},
"NewPlanMaxGroupTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"max_group_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"max_group_tiered_package_config": {
"$ref": "#/components/schemas/MaxGroupTieredPackageConfig",
"description": "Configuration for max_group_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"max_group_tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMaxGroupTieredPackagePrice"
},
"NewPlanMeteredAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"metered_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"metered_allowance_config": {
"$ref": "#/components/schemas/MeteredAllowanceConfig",
"description": "Configuration for metered_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"metered_allowance_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMeteredAllowancePrice"
},
"NewPlanMinimumCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"minimum_composite"
],
"title": "Model Type",
"description": "The pricing model type"
},
"minimum_composite_config": {
"$ref": "#/components/schemas/MinimumCompositeConfig",
"description": "Configuration for minimum_composite pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"minimum_composite_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanMinimumCompositePrice"
},
"NewPlanPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_config": {
"$ref": "#/components/schemas/PackageConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanPackagePrice"
},
"NewPlanPackageWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_with_allocation_config": {
"$ref": "#/components/schemas/PackageWithAllocationConfig",
"description": "Configuration for package_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_with_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanPackageWithAllocationPrice"
},
"NewPlanPercentCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"percent_config": {
"$ref": "#/components/schemas/PercentCompositeConfig",
"description": "Configuration for percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"percent_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanPercentCompositePrice"
},
"NewPlanPhase": {
"properties": {
"order": {
"type": "integer",
"title": "Order",
"description": "Determines the ordering of the phase in a plan's lifecycle. 1 = first phase."
},
"duration": {
"oneOf": [
{
"type": "integer",
"exclusiveMinimum": 0.0
},
{
"type": "null"
}
],
"title": "Duration",
"description": "How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely"
},
"duration_unit": {
"oneOf": [
{
"type": "string",
"enum": [
"daily",
"monthly",
"quarterly",
"semi_annual",
"annual"
]
},
{
"type": "null"
}
],
"title": "Duration Unit"
},
"align_billing_with_phase_start_date": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Align Billing With Phase Start Date",
"description": "Align billing cycle day with phase start date.",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"order"
],
"title": "NewPlanPhase"
},
"NewPlanPrice": {
"oneOf": [
{
"$ref": "#/components/schemas/NewPlanUnitPrice"
},
{
"$ref": "#/components/schemas/NewPlanTieredPrice"
},
{
"$ref": "#/components/schemas/NewPlanBulkPrice"
},
{
"$ref": "#/components/schemas/NewPlanBulkWithFiltersPrice"
},
{
"$ref": "#/components/schemas/NewPlanPackagePrice"
},
{
"$ref": "#/components/schemas/NewPlanMatrixPrice"
},
{
"$ref": "#/components/schemas/NewPlanThresholdTotalAmountPrice"
},
{
"$ref": "#/components/schemas/NewPlanTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewPlanTieredWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedTieredPrice"
},
{
"$ref": "#/components/schemas/NewPlanTieredPackageWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewPlanPackageWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewPlanUnitWithPercentPrice"
},
{
"$ref": "#/components/schemas/NewPlanMatrixWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewPlanMatrixWithThresholdDiscountsPrice"
},
{
"$ref": "#/components/schemas/NewPlanTieredWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewPlanUnitWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewPlanBulkWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedWithProratedMinimumPrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedWithMeteredMinimumPrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedWithMinMaxThresholdsPrice"
},
{
"$ref": "#/components/schemas/NewPlanMatrixWithDisplayNamePrice"
},
{
"$ref": "#/components/schemas/NewPlanGroupedTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewPlanMaxGroupTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewPlanScalableMatrixWithUnitPricingPrice"
},
{
"$ref": "#/components/schemas/NewPlanScalableMatrixWithTieredPricingPrice"
},
{
"$ref": "#/components/schemas/NewPlanCumulativeGroupedBulkPrice"
},
{
"$ref": "#/components/schemas/NewPlanCumulativeGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewPlanDailyCreditAllowancePrice"
},
{
"$ref": "#/components/schemas/NewPlanMeteredAllowancePrice"
},
{
"$ref": "#/components/schemas/NewPlanMinimumCompositePrice"
},
{
"$ref": "#/components/schemas/NewPlanPercentCompositePrice"
},
{
"$ref": "#/components/schemas/NewPlanEventOutputPrice"
}
],
"description": "New plan price request body params.",
"discriminator": {
"propertyName": "model_type",
"mapping": {
"bulk": "#/components/schemas/NewPlanBulkPrice",
"bulk_with_filters": "#/components/schemas/NewPlanBulkWithFiltersPrice",
"bulk_with_proration": "#/components/schemas/NewPlanBulkWithProrationPrice",
"cumulative_grouped_allocation": "#/components/schemas/NewPlanCumulativeGroupedAllocationPrice",
"cumulative_grouped_bulk": "#/components/schemas/NewPlanCumulativeGroupedBulkPrice",
"daily_credit_allowance": "#/components/schemas/NewPlanDailyCreditAllowancePrice",
"event_output": "#/components/schemas/NewPlanEventOutputPrice",
"grouped_allocation": "#/components/schemas/NewPlanGroupedAllocationPrice",
"grouped_tiered": "#/components/schemas/NewPlanGroupedTieredPrice",
"grouped_tiered_package": "#/components/schemas/NewPlanGroupedTieredPackagePrice",
"grouped_with_metered_minimum": "#/components/schemas/NewPlanGroupedWithMeteredMinimumPrice",
"grouped_with_min_max_thresholds": "#/components/schemas/NewPlanGroupedWithMinMaxThresholdsPrice",
"grouped_with_prorated_minimum": "#/components/schemas/NewPlanGroupedWithProratedMinimumPrice",
"matrix": "#/components/schemas/NewPlanMatrixPrice",
"matrix_with_allocation": "#/components/schemas/NewPlanMatrixWithAllocationPrice",
"matrix_with_display_name": "#/components/schemas/NewPlanMatrixWithDisplayNamePrice",
"matrix_with_threshold_discounts": "#/components/schemas/NewPlanMatrixWithThresholdDiscountsPrice",
"max_group_tiered_package": "#/components/schemas/NewPlanMaxGroupTieredPackagePrice",
"metered_allowance": "#/components/schemas/NewPlanMeteredAllowancePrice",
"minimum_composite": "#/components/schemas/NewPlanMinimumCompositePrice",
"package": "#/components/schemas/NewPlanPackagePrice",
"package_with_allocation": "#/components/schemas/NewPlanPackageWithAllocationPrice",
"percent": "#/components/schemas/NewPlanPercentCompositePrice",
"scalable_matrix_with_tiered_pricing": "#/components/schemas/NewPlanScalableMatrixWithTieredPricingPrice",
"scalable_matrix_with_unit_pricing": "#/components/schemas/NewPlanScalableMatrixWithUnitPricingPrice",
"threshold_total_amount": "#/components/schemas/NewPlanThresholdTotalAmountPrice",
"tiered": "#/components/schemas/NewPlanTieredPrice",
"tiered_package": "#/components/schemas/NewPlanTieredPackagePrice",
"tiered_package_with_minimum": "#/components/schemas/NewPlanTieredPackageWithMinimumPrice",
"tiered_with_minimum": "#/components/schemas/NewPlanTieredWithMinimumPrice",
"tiered_with_proration": "#/components/schemas/NewPlanTieredWithProrationPrice",
"unit": "#/components/schemas/NewPlanUnitPrice",
"unit_with_percent": "#/components/schemas/NewPlanUnitWithPercentPrice",
"unit_with_proration": "#/components/schemas/NewPlanUnitWithProrationPrice"
}
}
},
"NewPlanScalableMatrixWithTieredPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_tiered_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_tiered_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredPricingConfig",
"description": "Configuration for scalable_matrix_with_tiered_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_tiered_pricing_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanScalableMatrixWithTieredPricingPrice"
},
"NewPlanScalableMatrixWithUnitPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_unit_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_unit_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithUnitPricingConfig",
"description": "Configuration for scalable_matrix_with_unit_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_unit_pricing_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanScalableMatrixWithUnitPricingPrice"
},
"NewPlanThresholdTotalAmountPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"threshold_total_amount"
],
"title": "Model Type",
"description": "The pricing model type"
},
"threshold_total_amount_config": {
"$ref": "#/components/schemas/ThresholdTotalAmountConfig",
"description": "Configuration for threshold_total_amount pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"threshold_total_amount_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanThresholdTotalAmountPrice"
},
"NewPlanTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_config": {
"$ref": "#/components/schemas/TieredPackagePricingConfig",
"description": "Configuration for tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanTieredPackagePrice"
},
"NewPlanTieredPackageWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_with_minimum_config": {
"$ref": "#/components/schemas/TieredPackagePricingWithMinimumConfig",
"description": "Configuration for tiered_package_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_with_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanTieredPackageWithMinimumPrice"
},
"NewPlanTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_config": {
"$ref": "#/components/schemas/TieredConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanTieredPrice"
},
"NewPlanTieredWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_minimum_config": {
"$ref": "#/components/schemas/TieredPricingWithMinimumConfig",
"description": "Configuration for tiered_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanTieredWithMinimumPrice"
},
"NewPlanTieredWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_proration_config": {
"$ref": "#/components/schemas/TieredWithProrationConfig",
"description": "Configuration for tiered_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanTieredWithProrationPrice"
},
"NewPlanUnitPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanUnitPrice"
},
"NewPlanUnitWithPercentPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_percent_config": {
"$ref": "#/components/schemas/UnitWithPercentConfig",
"description": "Configuration for unit_with_percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_percent_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanUnitWithPercentPrice"
},
"NewPlanUnitWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_proration_config": {
"$ref": "#/components/schemas/UnitWithProrationConfig",
"description": "Configuration for unit_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewPlanUnitWithProrationPrice"
},
"NewPlanVersion": {
"properties": {
"add_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddPlanPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Prices",
"description": "Additional prices to be added to the plan."
},
"remove_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemovePlanPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Prices",
"description": "Prices to be removed from the plan."
},
"replace_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplacePlanPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Prices",
"description": "Prices to be replaced with additional prices on the plan."
},
"add_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddPlanAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Adjustments",
"description": "Additional adjustments to be added to the plan."
},
"remove_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemovePlanAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Adjustments",
"description": "Adjustments to be removed from the plan."
},
"replace_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplacePlanAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Adjustments",
"description": "Adjustments to be replaced with additional adjustments on the plan."
},
"set_as_default": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Set As Default",
"description": "Set this new plan version as the default"
},
"version": {
"type": "integer",
"title": "Version",
"description": "New version number."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"title": "NewPlanVersion"
},
"NewPortalSession": {
"properties": {
"expires_in_minutes": {
"type": "integer",
"maximum": 180.0,
"minimum": 1.0,
"title": "Expires In Minutes",
"description": "Duration in minutes until the portal session expires. Defaults to 60. Maximum 180.",
"default": 60
},
"invalidate_existing": {
"type": "boolean",
"title": "Invalidate Existing",
"description": "When true (default), creating this session soft-deletes any other active portal sessions for the customer. Set to false to allow concurrent sessions \u2014 useful when minting portal links for multiple authenticated end-users at once. The customer's permanent portal link (if any) is never invalidated by this.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"title": "NewPortalSession"
},
"NewReportingConfiguration": {
"properties": {
"exempt": {
"type": "boolean",
"title": "Exempt"
}
},
"type": "object",
"required": [
"exempt"
],
"title": "NewReportingConfiguration"
},
"NewSphereConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"sphere"
],
"title": "Tax Provider"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewSphereConfiguration"
},
"NewStripeTaxConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"stripe"
],
"title": "Tax Provider"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewStripeTaxConfiguration"
},
"NewSubscription": {
"properties": {
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer's customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer's children."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.",
"examples": [
"my_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Id",
"description": "The plan that the given subscription should be switched to. Note that either this property or `external_plan_id` must be specified.",
"examples": [
"ZMwNQefe7J3ecf7W"
]
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or `plan_id` must be specified.",
"examples": [
"ZMwNQefe7J3ecf7W"
]
},
"price_overrides": {
"oneOf": [
{
"items": {
"deprecated": true
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Price Overrides",
"description": "Optionally provide a list of overrides for prices on the plan",
"deprecated": true
},
"per_credit_overage_amount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Per Credit Overage Amount",
"deprecated": true
},
"credits_overage_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Credits Overage Rate",
"deprecated": true
},
"trial_duration_days": {
"oneOf": [
{
"type": "integer",
"exclusiveMaximum": 1000000.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Trial Duration Days",
"description": "The duration of the trial period in days. If not provided, this defaults to the value specified in the plan. If `0` is provided, the trial on the plan will be skipped."
},
"net_terms": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0. If not provided, this defaults to the value specified in the plan."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. If not specified, this defaults to the behavior configured for this customer."
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Determines the default memo on this subscription's invoices. Note that if this is not provided, it is determined by the plan configuration."
},
"coupon_redemption_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Coupon Redemption Code",
"description": "Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the subscription creation or plan change will not be scheduled."
},
"invoicing_threshold": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoicing Threshold",
"description": "When this subscription's accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.",
"examples": [
"10.00"
]
},
"initial_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Initial Phase Order",
"description": "The phase of the plan to start with",
"examples": [
2
]
},
"add_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Prices",
"description": "Additional prices to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"remove_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemoveSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Prices",
"description": "Plan prices to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"replace_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplaceSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Prices",
"description": "Plan prices to be replaced with additional prices on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"add_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Adjustments",
"description": "Additional adjustments to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"remove_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemoveSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Adjustments",
"description": "Plan adjustments to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"replace_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplaceSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Adjustments",
"description": "Plan adjustments to be replaced with additional adjustments on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id"
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency to use for the subscription. If not specified, the invoicing currency for the plan will be used."
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"description": "The name to use for the subscription. If not specified, the plan name will be used."
},
"start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Start Date"
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
},
"plan_version_number": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Version Number",
"description": "Specifies which version of the plan to subscribe to. If null, the default version will be used."
},
"external_marketplace": {
"oneOf": [
{
"type": "string",
"enum": [
"google",
"aws",
"azure"
]
},
{
"type": "null"
}
],
"title": "External Marketplace",
"deprecated": true
},
"external_marketplace_reporting_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Marketplace Reporting Id",
"deprecated": true
},
"aws_region": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Aws Region",
"deprecated": true
},
"align_billing_with_subscription_start_date": {
"type": "boolean",
"title": "Align Billing With Subscription Start Date",
"default": false
},
"billing_cycle_anchor_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleAnchorConfiguration"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"type": "object",
"title": "NewSubscription"
},
"NewSubscriptionBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_config": {
"$ref": "#/components/schemas/BulkConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionBulkPrice"
},
"NewSubscriptionBulkWithFiltersPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_filters"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_filters_config": {
"$ref": "#/components/schemas/BulkWithFiltersConfig",
"description": "Configuration for bulk_with_filters pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_filters_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionBulkWithFiltersPrice"
},
"NewSubscriptionBulkWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"bulk_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"bulk_with_proration_config": {
"$ref": "#/components/schemas/BulkWithProrationConfig",
"description": "Configuration for bulk_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"bulk_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionBulkWithProrationPrice"
},
"NewSubscriptionCumulativeGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_allocation_config": {
"$ref": "#/components/schemas/CumulativeGroupedAllocationConfig",
"description": "Configuration for cumulative_grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionCumulativeGroupedAllocationPrice"
},
"NewSubscriptionCumulativeGroupedBulkPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"cumulative_grouped_bulk"
],
"title": "Model Type",
"description": "The pricing model type"
},
"cumulative_grouped_bulk_config": {
"$ref": "#/components/schemas/CumulativeGroupedBulkConfig",
"description": "Configuration for cumulative_grouped_bulk pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"cumulative_grouped_bulk_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionCumulativeGroupedBulkPrice"
},
"NewSubscriptionDailyCreditAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"daily_credit_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"daily_credit_allowance_config": {
"$ref": "#/components/schemas/DailyCreditAllowanceConfig",
"description": "Configuration for daily_credit_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"daily_credit_allowance_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionDailyCreditAllowancePrice"
},
"NewSubscriptionEventOutputPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"event_output"
],
"title": "Model Type",
"description": "The pricing model type"
},
"event_output_config": {
"$ref": "#/components/schemas/EventOutputConfig",
"description": "Configuration for event_output pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"event_output_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionEventOutputPrice"
},
"NewSubscriptionGroupedAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_allocation_config": {
"$ref": "#/components/schemas/GroupedAllocationConfig",
"description": "Configuration for grouped_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedAllocationPrice"
},
"NewSubscriptionGroupedTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_package_config": {
"$ref": "#/components/schemas/GroupedTieredPackagePricingConfig",
"description": "Configuration for grouped_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedTieredPackagePrice"
},
"NewSubscriptionGroupedTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_tiered_config": {
"$ref": "#/components/schemas/GroupedTieredConfig",
"description": "Configuration for grouped_tiered pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_tiered_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedTieredPrice"
},
"NewSubscriptionGroupedWithMeteredMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_metered_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_metered_minimum_config": {
"$ref": "#/components/schemas/GroupedWithMeteredMinimumConfig",
"description": "Configuration for grouped_with_metered_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_metered_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedWithMeteredMinimumPrice"
},
"NewSubscriptionGroupedWithMinMaxThresholdsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_min_max_thresholds"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_min_max_thresholds_config": {
"$ref": "#/components/schemas/GroupedWithMinMaxThresholdsConfig",
"description": "Configuration for grouped_with_min_max_thresholds pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_min_max_thresholds_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedWithMinMaxThresholdsPrice"
},
"NewSubscriptionGroupedWithProratedMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"grouped_with_prorated_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"grouped_with_prorated_minimum_config": {
"$ref": "#/components/schemas/GroupedWithProratedMinimumConfig",
"description": "Configuration for grouped_with_prorated_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"grouped_with_prorated_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionGroupedWithProratedMinimumPrice"
},
"NewSubscriptionMatrixPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_config": {
"$ref": "#/components/schemas/MatrixConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMatrixPrice"
},
"NewSubscriptionMatrixWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_allocation_config": {
"$ref": "#/components/schemas/MatrixWithAllocationConfig",
"description": "Configuration for matrix_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMatrixWithAllocationPrice"
},
"NewSubscriptionMatrixWithDisplayNamePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_display_name"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_display_name_config": {
"$ref": "#/components/schemas/MatrixWithDisplayNameConfig",
"description": "Configuration for matrix_with_display_name pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_display_name_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMatrixWithDisplayNamePrice"
},
"NewSubscriptionMatrixWithThresholdDiscountsPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"matrix_with_threshold_discounts"
],
"title": "Model Type",
"description": "The pricing model type"
},
"matrix_with_threshold_discounts_config": {
"$ref": "#/components/schemas/MatrixWithThresholdDiscountsConfig",
"description": "Configuration for matrix_with_threshold_discounts pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"matrix_with_threshold_discounts_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMatrixWithThresholdDiscountsPrice"
},
"NewSubscriptionMaxGroupTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"max_group_tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"max_group_tiered_package_config": {
"$ref": "#/components/schemas/MaxGroupTieredPackageConfig",
"description": "Configuration for max_group_tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"max_group_tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMaxGroupTieredPackagePrice"
},
"NewSubscriptionMeteredAllowancePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"metered_allowance"
],
"title": "Model Type",
"description": "The pricing model type"
},
"metered_allowance_config": {
"$ref": "#/components/schemas/MeteredAllowanceConfig",
"description": "Configuration for metered_allowance pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"metered_allowance_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMeteredAllowancePrice"
},
"NewSubscriptionMinimumCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"minimum_composite"
],
"title": "Model Type",
"description": "The pricing model type"
},
"minimum_composite_config": {
"$ref": "#/components/schemas/MinimumCompositeConfig",
"description": "Configuration for minimum_composite pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"minimum_composite_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionMinimumCompositePrice"
},
"NewSubscriptionPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_config": {
"$ref": "#/components/schemas/PackageConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionPackagePrice"
},
"NewSubscriptionPackageWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_with_allocation_config": {
"$ref": "#/components/schemas/PackageWithAllocationConfig",
"description": "Configuration for package_with_allocation pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"package_with_allocation_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionPackageWithAllocationPrice"
},
"NewSubscriptionPercentCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"percent_config": {
"$ref": "#/components/schemas/PercentCompositeConfig",
"description": "Configuration for percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"percent_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionPercentCompositePrice"
},
"NewSubscriptionPrice": {
"oneOf": [
{
"$ref": "#/components/schemas/NewSubscriptionUnitPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionTieredPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionBulkPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionBulkWithFiltersPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionPackagePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMatrixPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionThresholdTotalAmountPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionTieredWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedTieredPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionTieredPackageWithMinimumPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionPackageWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionUnitWithPercentPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMatrixWithAllocationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMatrixWithThresholdDiscountsPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionTieredWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionUnitWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionBulkWithProrationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedWithProratedMinimumPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedWithMeteredMinimumPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedWithMinMaxThresholdsPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMatrixWithDisplayNamePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionGroupedTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMaxGroupTieredPackagePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionScalableMatrixWithUnitPricingPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionScalableMatrixWithTieredPricingPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionCumulativeGroupedBulkPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionCumulativeGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionDailyCreditAllowancePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMeteredAllowancePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionMinimumCompositePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionPercentCompositePrice"
},
{
"$ref": "#/components/schemas/NewSubscriptionEventOutputPrice"
}
],
"description": "New subscription price request body params.",
"discriminator": {
"propertyName": "model_type",
"mapping": {
"bulk": "#/components/schemas/NewSubscriptionBulkPrice",
"bulk_with_filters": "#/components/schemas/NewSubscriptionBulkWithFiltersPrice",
"bulk_with_proration": "#/components/schemas/NewSubscriptionBulkWithProrationPrice",
"cumulative_grouped_allocation": "#/components/schemas/NewSubscriptionCumulativeGroupedAllocationPrice",
"cumulative_grouped_bulk": "#/components/schemas/NewSubscriptionCumulativeGroupedBulkPrice",
"daily_credit_allowance": "#/components/schemas/NewSubscriptionDailyCreditAllowancePrice",
"event_output": "#/components/schemas/NewSubscriptionEventOutputPrice",
"grouped_allocation": "#/components/schemas/NewSubscriptionGroupedAllocationPrice",
"grouped_tiered": "#/components/schemas/NewSubscriptionGroupedTieredPrice",
"grouped_tiered_package": "#/components/schemas/NewSubscriptionGroupedTieredPackagePrice",
"grouped_with_metered_minimum": "#/components/schemas/NewSubscriptionGroupedWithMeteredMinimumPrice",
"grouped_with_min_max_thresholds": "#/components/schemas/NewSubscriptionGroupedWithMinMaxThresholdsPrice",
"grouped_with_prorated_minimum": "#/components/schemas/NewSubscriptionGroupedWithProratedMinimumPrice",
"matrix": "#/components/schemas/NewSubscriptionMatrixPrice",
"matrix_with_allocation": "#/components/schemas/NewSubscriptionMatrixWithAllocationPrice",
"matrix_with_display_name": "#/components/schemas/NewSubscriptionMatrixWithDisplayNamePrice",
"matrix_with_threshold_discounts": "#/components/schemas/NewSubscriptionMatrixWithThresholdDiscountsPrice",
"max_group_tiered_package": "#/components/schemas/NewSubscriptionMaxGroupTieredPackagePrice",
"metered_allowance": "#/components/schemas/NewSubscriptionMeteredAllowancePrice",
"minimum_composite": "#/components/schemas/NewSubscriptionMinimumCompositePrice",
"package": "#/components/schemas/NewSubscriptionPackagePrice",
"package_with_allocation": "#/components/schemas/NewSubscriptionPackageWithAllocationPrice",
"percent": "#/components/schemas/NewSubscriptionPercentCompositePrice",
"scalable_matrix_with_tiered_pricing": "#/components/schemas/NewSubscriptionScalableMatrixWithTieredPricingPrice",
"scalable_matrix_with_unit_pricing": "#/components/schemas/NewSubscriptionScalableMatrixWithUnitPricingPrice",
"threshold_total_amount": "#/components/schemas/NewSubscriptionThresholdTotalAmountPrice",
"tiered": "#/components/schemas/NewSubscriptionTieredPrice",
"tiered_package": "#/components/schemas/NewSubscriptionTieredPackagePrice",
"tiered_package_with_minimum": "#/components/schemas/NewSubscriptionTieredPackageWithMinimumPrice",
"tiered_with_minimum": "#/components/schemas/NewSubscriptionTieredWithMinimumPrice",
"tiered_with_proration": "#/components/schemas/NewSubscriptionTieredWithProrationPrice",
"unit": "#/components/schemas/NewSubscriptionUnitPrice",
"unit_with_percent": "#/components/schemas/NewSubscriptionUnitWithPercentPrice",
"unit_with_proration": "#/components/schemas/NewSubscriptionUnitWithProrationPrice"
}
}
},
"NewSubscriptionScalableMatrixWithTieredPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_tiered_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_tiered_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredPricingConfig",
"description": "Configuration for scalable_matrix_with_tiered_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_tiered_pricing_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionScalableMatrixWithTieredPricingPrice"
},
"NewSubscriptionScalableMatrixWithUnitPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_unit_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_unit_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithUnitPricingConfig",
"description": "Configuration for scalable_matrix_with_unit_pricing pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_unit_pricing_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionScalableMatrixWithUnitPricingPrice"
},
"NewSubscriptionThresholdTotalAmountPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"threshold_total_amount"
],
"title": "Model Type",
"description": "The pricing model type"
},
"threshold_total_amount_config": {
"$ref": "#/components/schemas/ThresholdTotalAmountConfig",
"description": "Configuration for threshold_total_amount pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"threshold_total_amount_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionThresholdTotalAmountPrice"
},
"NewSubscriptionTieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_config": {
"$ref": "#/components/schemas/TieredPackagePricingConfig",
"description": "Configuration for tiered_package pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionTieredPackagePrice"
},
"NewSubscriptionTieredPackageWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_with_minimum_config": {
"$ref": "#/components/schemas/TieredPackagePricingWithMinimumConfig",
"description": "Configuration for tiered_package_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_package_with_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionTieredPackageWithMinimumPrice"
},
"NewSubscriptionTieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_config": {
"$ref": "#/components/schemas/TieredConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionTieredPrice"
},
"NewSubscriptionTieredWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_minimum_config": {
"$ref": "#/components/schemas/TieredPricingWithMinimumConfig",
"description": "Configuration for tiered_with_minimum pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_minimum_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionTieredWithMinimumPrice"
},
"NewSubscriptionTieredWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_proration_config": {
"$ref": "#/components/schemas/TieredWithProrationConfig",
"description": "Configuration for tiered_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"tiered_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionTieredWithProrationPrice"
},
"NewSubscriptionUnitPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionUnitPrice"
},
"NewSubscriptionUnitWithPercentPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_percent_config": {
"$ref": "#/components/schemas/UnitWithPercentConfig",
"description": "Configuration for unit_with_percent pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_percent_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionUnitWithPercentPrice"
},
"NewSubscriptionUnitWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_proration_config": {
"$ref": "#/components/schemas/UnitWithProrationConfig",
"description": "Configuration for unit_with_proration pricing"
},
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "An alias for the price."
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the price.",
"examples": [
"Annual fee"
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewDimensionalPriceConfiguration"
},
{
"type": "null"
}
],
"description": "For dimensional price: specifies a price group and dimension values"
},
"license_type_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "License Type Id",
"description": "The ID of the license type to associate with this price."
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "The id of the billable metric for the price. Only needed if the price is usage-based."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The id of the item the price will be associated with."
},
"billed_in_advance": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Billed In Advance",
"description": "If the Price represents a fixed cost, the price will be billed in-advance if this is true, and in-arrears if this is false."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "If the Price represents a fixed cost, this represents the quantity of units applied."
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key",
"description": "The property used to group this price on an invoice"
},
"cadence": {
"type": "string",
"enum": [
"annual",
"semi_annual",
"monthly",
"quarterly",
"one_time",
"custom"
],
"title": "Cadence",
"description": "The cadence to bill for this price on."
},
"billing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "For custom cadence: specifies the duration of the billing period in days or months."
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewBillingCycleConfiguration"
},
{
"type": "null"
}
],
"description": "Within each billing cycle, specifies the cadence at which invoices are produced. If unspecified, a single invoice is produced per billing cycle."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
],
"description": "The configuration for the rate of the price currency to the invoicing currency."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "An ISO 4217 currency string, or custom pricing unit identifier, in which this price is billed."
},
"reference_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reference Id",
"description": "A transient ID that can be used to reference this price when adding adjustments in the same API call."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"model_type",
"unit_with_proration_config",
"name",
"item_id",
"cadence"
],
"title": "NewSubscriptionUnitWithProrationPrice"
},
"NewTaxConfiguration": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAvalaraTaxConfiguration"
},
{
"$ref": "#/components/schemas/NewTaxJarConfiguration"
},
{
"$ref": "#/components/schemas/NewSphereConfiguration"
},
{
"$ref": "#/components/schemas/NewNumeralConfiguration"
},
{
"$ref": "#/components/schemas/NewAnrokConfiguration"
},
{
"$ref": "#/components/schemas/NewStripeTaxConfiguration"
}
],
"discriminator": {
"propertyName": "tax_provider",
"mapping": {
"anrok": "#/components/schemas/NewAnrokConfiguration",
"avalara": "#/components/schemas/NewAvalaraTaxConfiguration",
"numeral": "#/components/schemas/NewNumeralConfiguration",
"sphere": "#/components/schemas/NewSphereConfiguration",
"stripe": "#/components/schemas/NewStripeTaxConfiguration",
"taxjar": "#/components/schemas/NewTaxJarConfiguration"
}
}
},
"NewTaxJarConfiguration": {
"properties": {
"tax_exempt": {
"type": "boolean",
"title": "Tax Exempt"
},
"automatic_tax_enabled": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Automatic Tax Enabled",
"description": "Whether to automatically calculate tax for this customer. When null, inherits from account-level setting. When true or false, overrides the account setting."
},
"tax_provider": {
"type": "string",
"enum": [
"taxjar"
],
"title": "Tax Provider"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tax_exempt",
"tax_provider"
],
"title": "NewTaxJarConfiguration"
},
"NewTopUpInvoiceSettings": {
"properties": {
"auto_collection": {
"type": "boolean",
"title": "Auto Collection",
"description": "Whether the credits purchase invoice should auto collect with the customer's saved payment method."
},
"net_terms": {
"type": "integer",
"title": "Net Terms",
"description": "The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0."
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo to display on the invoice."
},
"require_successful_payment": {
"type": "boolean",
"title": "Require Successful Payment",
"description": "When true, credit blocks created by this top-up will require that the corresponding invoice is paid before they are drawn down from. If any topup block is pending payment, further automatic top-ups will be paused until the invoice is paid or voided.",
"default": false
}
},
"type": "object",
"required": [
"auto_collection",
"net_terms"
],
"title": "NewTopUpInvoiceSettings"
},
"NewUsageDiscount": {
"properties": {
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "The set of price IDs to which this adjustment applies.",
"examples": [
[
"price_1",
"price_2"
]
]
},
"applies_to_item_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true
},
{
"type": "null"
}
],
"title": "Applies To Item Ids",
"description": "The set of item IDs to which this adjustment applies.",
"examples": [
[
"item_1",
"item_2"
]
]
},
"applies_to_all": {
"oneOf": [
{
"type": "boolean",
"enum": [
true
]
},
{
"type": "null"
}
],
"title": "Applies To All",
"description": "If set, the adjustment will apply to every price on the subscription."
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "A list of filters that determine which prices this adjustment will apply to."
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "If set, only prices in the specified currency will have the adjustment applied.",
"examples": [
[
"USD",
"JPY",
"credits"
]
]
},
"price_type": {
"oneOf": [
{
"type": "string",
"enum": [
"usage",
"fixed_in_advance",
"fixed_in_arrears",
"fixed",
"in_arrears"
]
},
{
"type": "null"
}
],
"title": "Price Type",
"description": "If set, only prices of the specified type will have the adjustment applied."
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "When false, this adjustment will be applied to a single price. Otherwise, it will be applied at the invoice level, possibly to multiple prices.",
"default": true
},
"adjustment_type": {
"type": "string",
"enum": [
"usage_discount"
],
"title": "Adjustment Type"
},
"usage_discount": {
"type": "number",
"title": "Usage Discount"
}
},
"type": "object",
"required": [
"adjustment_type",
"usage_discount"
],
"title": "NewUsageDiscount"
},
"OtherSubLineItem": {
"properties": {
"amount": {
"type": "string",
"title": "Amount",
"description": "The total amount for this sub line item.",
"examples": [
"9.00"
]
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"Tier One"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"examples": [
5
]
},
"grouping": {
"oneOf": [
{
"$ref": "#/components/schemas/SubLineItemGrouping"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"'null'"
],
"title": "Type"
}
},
"type": "object",
"required": [
"amount",
"name",
"quantity",
"grouping",
"type"
],
"title": "OtherSubLineItem"
},
"PackageConfig": {
"properties": {
"package_amount": {
"type": "string",
"title": "Package Amount",
"description": "A currency amount to rate usage by"
},
"package_size": {
"type": "integer",
"minimum": 1.0,
"title": "Package Size",
"description": "An integer amount to represent package size. For example, 1000 here would divide usage by 1000 before multiplying by package_amount in rating"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"package_amount",
"package_size"
],
"title": "PackageConfig",
"description": "Configuration for package pricing"
},
"PackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_config": {
"$ref": "#/components/schemas/PackageConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"package_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "PackagePrice"
},
"PackageWithAllocationConfig": {
"properties": {
"package_amount": {
"type": "string",
"title": "Package Amount"
},
"package_size": {
"type": "string",
"title": "Package Size"
},
"allocation": {
"type": "string",
"title": "Allocation"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"package_amount",
"package_size",
"allocation"
],
"title": "PackageWithAllocationConfig",
"description": "Configuration for package pricing with usage allocation"
},
"PackageWithAllocationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"package_with_allocation"
],
"title": "Model Type",
"description": "The pricing model type"
},
"package_with_allocation_config": {
"$ref": "#/components/schemas/PackageWithAllocationConfig",
"description": "Configuration for package_with_allocation pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"package_with_allocation_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "PackageWithAllocationPrice"
},
"PaginationMetadata": {
"properties": {
"has_more": {
"type": "boolean",
"title": "Has More"
},
"next_cursor": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Next Cursor"
}
},
"type": "object",
"required": [
"has_more",
"next_cursor"
],
"title": "PaginationMetadata"
},
"PayInvoiceParams": {
"properties": {
"shared_payment_token_id": {
"type": "string",
"title": "Shared Payment Token Id",
"description": "The ID of a shared payment token granted by an agent to use for this payment."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"shared_payment_token_id"
],
"title": "PayInvoiceParams"
},
"PaymentAttempt": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "The ID of the payment attempt."
},
"payment_provider": {
"oneOf": [
{
"type": "string",
"enum": [
"stripe"
]
},
{
"type": "null"
}
],
"title": "Payment Provider",
"description": "The payment provider that attempted to collect the payment."
},
"payment_provider_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Payment Provider Id",
"description": "The ID of the payment attempt in the payment provider."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount of the payment attempt."
},
"succeeded": {
"type": "boolean",
"title": "Succeeded",
"description": "Whether the payment attempt succeeded."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The time at which the payment attempt was created."
},
"receipt_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Receipt Pdf",
"description": "URL to the downloadable PDF version of the receipt. This field will be `null` for payment attempts that did not succeed.",
"examples": [
"https://assets.withorb.com/receipt/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
]
}
},
"type": "object",
"required": [
"id",
"payment_provider",
"payment_provider_id",
"amount",
"succeeded",
"created_at",
"receipt_pdf"
],
"title": "PaymentAttempt"
},
"PaymentConfiguration": {
"properties": {
"payment_providers": {
"items": {
"$ref": "#/components/schemas/PaymentConfigurationItem"
},
"type": "array",
"title": "Payment Providers",
"description": "Provider-specific payment configuration.",
"default": []
}
},
"type": "object",
"title": "PaymentConfiguration"
},
"PaymentConfigurationItem": {
"properties": {
"provider_type": {
"type": "string",
"enum": [
"stripe"
],
"title": "Provider Type",
"description": "The payment provider to configure."
},
"excluded_payment_method_types": {
"items": {
"type": "string"
},
"type": "array",
"title": "Excluded Payment Method Types",
"description": "List of Stripe payment method types to exclude for this customer. Excluded payment methods will not be available for the customer to select during payment, and will not be used for auto-collection. If a customer's default payment method becomes excluded, Orb will attempt to use the next available compatible payment method for auto-collection.",
"default": []
},
"default_shared_payment_token": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Shared Payment Token",
"description": "The ID of a shared payment token granted by an agent to use as the default payment instrument for this customer. When set, auto-collection will use this token instead of the customer's default payment method."
}
},
"type": "object",
"required": [
"provider_type"
],
"title": "PaymentConfigurationItem"
},
"PerPriceCost": {
"properties": {
"quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity",
"description": "The price's quantity for the timeframe"
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "Price's contributions for the timeframe, excluding any minimums and discounts."
},
"total": {
"type": "string",
"title": "Total",
"description": "Price's contributions for the timeframe, including minimums and discounts."
},
"price": {
"$ref": "#/components/schemas/Price",
"title": "Price",
"description": "The price object"
},
"price_id": {
"type": "string",
"title": "Price Id",
"description": "The price the cost is associated with"
}
},
"type": "object",
"required": [
"subtotal",
"total",
"price",
"price_id"
],
"title": "PerPriceCost"
},
"PercentCompositeConfig": {
"properties": {
"percent": {
"type": "number",
"title": "Percent",
"description": "What percent of the component subtotals to charge"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"percent"
],
"title": "PercentCompositeConfig",
"description": "Configuration for percent composite price"
},
"PercentCompositePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"percent_config": {
"$ref": "#/components/schemas/PercentCompositeConfig",
"description": "Configuration for percent pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"percent_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "PercentCompositePrice"
},
"PercentageDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage"
],
"title": "Discount Type"
},
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.",
"examples": [
[
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
]
]
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "The filters that determine which prices to apply this discount to."
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"percentage_discount": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Percentage Discount",
"description": "Only available if discount_type is `percentage`. This is a number between 0 and 1.",
"examples": [
0.15
]
}
},
"type": "object",
"required": [
"discount_type",
"percentage_discount"
],
"title": "PercentageDiscount"
},
"PercentageDiscountCreationParams": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage"
],
"title": "Discount Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount",
"description": "Only available if discount_type is `percentage`. This is a number between 0 and 1.",
"examples": [
0.15
],
"ge": 0.0,
"le": 1.0
}
},
"type": "object",
"required": [
"discount_type",
"percentage_discount"
],
"title": "PercentageDiscountCreationParams"
},
"PercentageDiscountInterval": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"percentage"
],
"title": "Discount Type"
},
"percentage_discount": {
"type": "number",
"title": "Percentage Discount",
"description": "Only available if discount_type is `percentage`.This is a number between 0 and 1.",
"examples": [
0.15
]
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the discount interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the discount interval."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices this discount interval applies to."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval ids that this discount interval applies to."
}
},
"type": "object",
"required": [
"discount_type",
"percentage_discount",
"start_date",
"end_date",
"filters",
"applies_to_price_interval_ids"
],
"title": "PercentageDiscountInterval"
},
"PingResponse": {
"properties": {
"response": {
"type": "string",
"title": "Response"
}
},
"type": "object",
"required": [
"response"
],
"title": "PingResponse"
},
"Plan": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"description": {
"type": "string",
"title": "Description"
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"status": {
"type": "string",
"enum": [
"active",
"archived",
"draft"
],
"title": "Status"
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"product": {
"$ref": "#/components/schemas/Product"
},
"version": {
"type": "integer",
"title": "Version"
},
"trial_config": {
"$ref": "#/components/schemas/TrialConfig"
},
"plan_phases": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PlanPhase"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Plan Phases"
},
"base_plan": {
"oneOf": [
{
"$ref": "#/components/schemas/PlanMinified"
},
{
"type": "null"
}
],
"description": "Legacy field representing the parent plan if the current plan is a 'child plan', overriding prices from the parent.",
"deprecated": true
},
"base_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Base Plan Id",
"description": "Legacy field representing the parent plan ID if the current plan is a 'child plan', overriding prices from the parent.",
"deprecated": true
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system."
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or custom pricing unit (`credits`) for this plan's prices.",
"deprecated": true
},
"invoicing_currency": {
"type": "string",
"title": "Invoicing Currency",
"description": "An ISO 4217 currency string for which this plan is billed in. Matches `currency` unless `currency` is a custom pricing unit."
},
"net_terms": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "Determines the difference between the invoice issue date and the due date. A value of \"0\" here signifies that invoices are due on issue, whereas a value of \"30\" means that the customer has a month to pay the invoice before its overdue. Note that individual subscriptions or invoices may set a different net terms configuration."
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "The default memo text on the invoices corresponding to subscriptions on this plan. Note that each subscription may configure its own memo."
},
"prices": {
"items": {
"$ref": "#/components/schemas/Price"
},
"type": "array",
"uniqueItems": true,
"title": "Prices",
"description": "Prices for this plan. If the plan has phases, this includes prices across all phases of the plan."
},
"adjustments": {
"items": {
"$ref": "#/components/schemas/Adjustment"
},
"type": "array",
"uniqueItems": true,
"title": "Adjustments",
"description": "Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan."
}
},
"type": "object",
"required": [
"metadata",
"id",
"name",
"description",
"maximum_amount",
"minimum_amount",
"created_at",
"status",
"maximum",
"minimum",
"discount",
"product",
"version",
"trial_config",
"plan_phases",
"base_plan",
"base_plan_id",
"external_plan_id",
"currency",
"invoicing_currency",
"net_terms",
"default_invoice_memo",
"prices",
"adjustments"
],
"title": "Plan",
"description": "The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a\ncustomer. Plans define the billing behavior of the subscription. You can see more about how to configure prices\nin the [Price resource](/reference/price)."
},
"PlanMinified": {
"properties": {
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"examples": [
"m2t5akQeh2obwxeU"
]
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.",
"examples": [
"m2t5akQeh2obwxeU"
]
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"examples": [
"Example plan"
]
}
},
"type": "object",
"required": [
"id",
"external_plan_id",
"name"
],
"title": "PlanMinified"
},
"PlanMinifiedWithVersion": {
"properties": {
"id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Id",
"examples": [
"m2t5akQeh2obwxeU"
]
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "An optional user-defined ID for this plan resource, used throughout the system as an alias for this Plan. Use this field to identify a plan by an existing identifier in your system.",
"examples": [
"m2t5akQeh2obwxeU"
]
},
"name": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Name",
"examples": [
"Example plan"
]
},
"plan_version": {
"type": "string",
"title": "Plan Version"
}
},
"type": "object",
"required": [
"id",
"external_plan_id",
"name",
"plan_version"
],
"title": "PlanMinifiedWithVersion"
},
"PlanPhase": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"duration": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Duration",
"description": "How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely"
},
"duration_unit": {
"oneOf": [
{
"type": "string",
"enum": [
"daily",
"monthly",
"quarterly",
"semi_annual",
"annual"
]
},
{
"type": "null"
}
],
"title": "Duration Unit"
},
"name": {
"type": "string",
"title": "Name"
},
"order": {
"type": "integer",
"title": "Order",
"description": "Determines the ordering of the phase in a plan's lifecycle. 1 = first phase."
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
]
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount"
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"id",
"description",
"duration",
"duration_unit",
"name",
"order",
"minimum",
"maximum",
"maximum_amount",
"minimum_amount",
"discount"
],
"title": "PlanPhase"
},
"PlanPhaseAmountDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"amount_discount"
],
"title": "Adjustment Type"
},
"amount_discount": {
"type": "string",
"title": "Amount Discount",
"description": "The amount by which to discount the prices this adjustment applies to in a given billing period."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The plan phase in which this adjustment is active."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"amount_discount",
"plan_phase_order"
],
"title": "PlanPhaseAmountDiscountAdjustment"
},
"PlanPhaseMaximumAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"maximum"
],
"title": "Adjustment Type"
},
"maximum_amount": {
"type": "string",
"title": "Maximum Amount",
"description": "The maximum amount to charge in a given billing period for the prices this adjustment applies to."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The plan phase in which this adjustment is active."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"maximum_amount",
"plan_phase_order"
],
"title": "PlanPhaseMaximumAdjustment"
},
"PlanPhaseMinimumAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"minimum"
],
"title": "Adjustment Type"
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount",
"description": "The minimum amount to charge in a given billing period for the prices this adjustment applies to."
},
"item_id": {
"type": "string",
"title": "Item Id",
"description": "The item ID that revenue from this minimum will be attributed to."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The plan phase in which this adjustment is active."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"minimum_amount",
"item_id",
"plan_phase_order"
],
"title": "PlanPhaseMinimumAdjustment"
},
"PlanPhasePercentageDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"percentage_discount"
],
"title": "Adjustment Type"
},
"percentage_discount": {
"type": "number",
"maximum": 1.0,
"minimum": 0.0,
"title": "Percentage Discount",
"description": "The percentage (as a value between 0 and 1) by which to discount the price intervals this adjustment applies to in a given billing period."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The plan phase in which this adjustment is active."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"percentage_discount",
"plan_phase_order"
],
"title": "PlanPhasePercentageDiscountAdjustment"
},
"PlanPhaseUsageDiscountAdjustment": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"is_invoice_level": {
"type": "boolean",
"title": "Is Invoice Level",
"description": "True for adjustments that apply to an entire invoice, false for adjustments that apply to only one price."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices to apply this adjustment to."
},
"applies_to_price_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Ids",
"description": "The price IDs that this adjustment applies to.",
"deprecated": true
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason",
"description": "The reason for the adjustment."
},
"replaces_adjustment_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Adjustment Id",
"description": "The adjustment id this adjustment replaces. This adjustment will take the place of the replaced adjustment in plan version migrations."
},
"adjustment_type": {
"type": "string",
"enum": [
"usage_discount"
],
"title": "Adjustment Type"
},
"usage_discount": {
"type": "number",
"title": "Usage Discount",
"description": "The number of usage units by which to discount the price this adjustment applies to in a given billing period."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The plan phase in which this adjustment is active."
}
},
"type": "object",
"required": [
"id",
"is_invoice_level",
"filters",
"applies_to_price_ids",
"reason",
"replaces_adjustment_id",
"adjustment_type",
"usage_discount",
"plan_phase_order"
],
"title": "PlanPhaseUsageDiscountAdjustment"
},
"PlanVersion": {
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"version": {
"type": "integer",
"title": "Version"
},
"plan_phases": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PlanVersionPhase"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Plan Phases"
},
"prices": {
"items": {
"$ref": "#/components/schemas/Price"
},
"type": "array",
"uniqueItems": true,
"title": "Prices",
"description": "Prices for this plan. If the plan has phases, this includes prices across all phases of the plan."
},
"adjustments": {
"items": {
"$ref": "#/components/schemas/Adjustment"
},
"type": "array",
"uniqueItems": true,
"title": "Adjustments",
"description": "Adjustments for this plan. If the plan has phases, this includes adjustments across all phases of the plan."
}
},
"type": "object",
"required": [
"created_at",
"version",
"plan_phases",
"prices",
"adjustments"
],
"title": "PlanVersion",
"description": "The PlanVersion resource represents the prices and adjustments present on a specific version of a plan."
},
"PlanVersionChange": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"description": "Unique identifier for this plan version change."
},
"plan_id": {
"type": "string",
"title": "Plan Id",
"description": "The ID of the plan being migrated."
},
"effective_time": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"enum": [
"end_of_term"
]
},
{
"type": "null"
}
],
"title": "Effective Time",
"description": "When the migration takes effect. Can be a specific date/time, or 'end_of_term' when scheduled to be at the end of the current billing period."
},
"status": {
"type": "string",
"enum": [
"not_started",
"in_progress",
"completed",
"action_needed",
"canceled"
],
"title": "Status",
"description": "Current status of the migration: 'not_started', 'in_progress', 'completed', 'action_needed', or 'canceled'."
}
},
"type": "object",
"required": [
"id",
"plan_id",
"effective_time",
"status"
],
"title": "PlanVersionChange"
},
"PlanVersionChanges": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/PlanVersionChange"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "PlanVersionChanges"
},
"PlanVersionPhase": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"duration": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Duration",
"description": "How many terms of length `duration_unit` this phase is active for. If null, this phase is evergreen and active indefinitely"
},
"duration_unit": {
"oneOf": [
{
"type": "string",
"enum": [
"daily",
"monthly",
"quarterly",
"semi_annual",
"annual"
]
},
{
"type": "null"
}
],
"title": "Duration Unit"
},
"name": {
"type": "string",
"title": "Name"
},
"order": {
"type": "integer",
"title": "Order",
"description": "Determines the ordering of the phase in a plan's lifecycle. 1 = first phase."
}
},
"type": "object",
"required": [
"id",
"description",
"duration",
"duration_unit",
"name",
"order"
],
"title": "PlanVersionPhase"
},
"Plans": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Plan"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Plans"
},
"PortalSession": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"customer_id": {
"type": "string",
"title": "Customer Id"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"expires_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Expires At"
},
"url": {
"type": "string",
"title": "Url"
}
},
"type": "object",
"required": [
"id",
"customer_id",
"created_at",
"expires_at",
"url"
],
"title": "PortalSession"
},
"PreviewEvent": {
"properties": {
"customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Customer Id",
"description": "The Orb Customer identifier"
},
"external_customer_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Customer Id",
"description": "An alias for the Orb customer, whose mapping is specified when creating the customer"
},
"event_name": {
"type": "string",
"title": "Event Name",
"description": "A name to meaningfully identify the action or event type."
},
"timestamp": {
"type": "string",
"format": "date-time",
"title": "Timestamp",
"description": "An ISO 8601 format date with no timezone offset (i.e. UTC). This should represent the time that usage was recorded, and is particularly important to attribute usage to a given billing period.",
"examples": [
"2020-12-09T16:09:53Z"
]
},
"properties": {
"additionalProperties": true,
"type": "object",
"title": "Properties",
"description": "A dictionary of custom properties. Values in this dictionary must be numeric, boolean, or strings. Nested dictionaries are disallowed."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"event_name",
"timestamp",
"properties"
],
"title": "PreviewEvent"
},
"Price": {
"oneOf": [
{
"$ref": "#/components/schemas/UnitPrice"
},
{
"$ref": "#/components/schemas/TieredPrice"
},
{
"$ref": "#/components/schemas/BulkPrice"
},
{
"$ref": "#/components/schemas/BulkWithFiltersPrice"
},
{
"$ref": "#/components/schemas/PackagePrice"
},
{
"$ref": "#/components/schemas/MatrixPrice"
},
{
"$ref": "#/components/schemas/ThresholdTotalAmountPrice"
},
{
"$ref": "#/components/schemas/TieredPackagePrice"
},
{
"$ref": "#/components/schemas/TieredWithMinimumPrice"
},
{
"$ref": "#/components/schemas/GroupedTieredPrice"
},
{
"$ref": "#/components/schemas/TieredPackageWithMinimumPrice"
},
{
"$ref": "#/components/schemas/PackageWithAllocationPrice"
},
{
"$ref": "#/components/schemas/UnitWithPercentPrice"
},
{
"$ref": "#/components/schemas/MatrixWithAllocationPrice"
},
{
"$ref": "#/components/schemas/MatrixWithThresholdDiscountsPrice"
},
{
"$ref": "#/components/schemas/TieredWithProrationPrice"
},
{
"$ref": "#/components/schemas/UnitWithProrationPrice"
},
{
"$ref": "#/components/schemas/GroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/BulkWithProrationPrice"
},
{
"$ref": "#/components/schemas/GroupedWithProratedMinimumPrice"
},
{
"$ref": "#/components/schemas/GroupedWithMeteredMinimumPrice"
},
{
"$ref": "#/components/schemas/GroupedWithMinMaxThresholdsPrice"
},
{
"$ref": "#/components/schemas/MatrixWithDisplayNamePrice"
},
{
"$ref": "#/components/schemas/GroupedTieredPackagePrice"
},
{
"$ref": "#/components/schemas/MaxGroupTieredPackagePrice"
},
{
"$ref": "#/components/schemas/ScalableMatrixWithUnitPricingPrice"
},
{
"$ref": "#/components/schemas/ScalableMatrixWithTieredPricingPrice"
},
{
"$ref": "#/components/schemas/CumulativeGroupedBulkPrice"
},
{
"$ref": "#/components/schemas/CumulativeGroupedAllocationPrice"
},
{
"$ref": "#/components/schemas/DailyCreditAllowancePrice"
},
{
"$ref": "#/components/schemas/MeteredAllowancePrice"
},
{
"$ref": "#/components/schemas/MinimumCompositePrice"
},
{
"$ref": "#/components/schemas/PercentCompositePrice"
},
{
"$ref": "#/components/schemas/EventOutputPrice"
}
],
"description": "The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in\nthe form of an invoice line item. Prices take a quantity and determine an amount to bill.\n\nOrb supports a few different pricing models out of the box. Each of these models is serialized differently in a\ngiven Price object. The model_type field determines the key for the configuration object that is present.\n\nFor more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)",
"discriminator": {
"propertyName": "model_type",
"mapping": {
"bulk": "#/components/schemas/BulkPrice",
"bulk_with_filters": "#/components/schemas/BulkWithFiltersPrice",
"bulk_with_proration": "#/components/schemas/BulkWithProrationPrice",
"cumulative_grouped_allocation": "#/components/schemas/CumulativeGroupedAllocationPrice",
"cumulative_grouped_bulk": "#/components/schemas/CumulativeGroupedBulkPrice",
"daily_credit_allowance": "#/components/schemas/DailyCreditAllowancePrice",
"event_output": "#/components/schemas/EventOutputPrice",
"grouped_allocation": "#/components/schemas/GroupedAllocationPrice",
"grouped_tiered": "#/components/schemas/GroupedTieredPrice",
"grouped_tiered_package": "#/components/schemas/GroupedTieredPackagePrice",
"grouped_with_metered_minimum": "#/components/schemas/GroupedWithMeteredMinimumPrice",
"grouped_with_min_max_thresholds": "#/components/schemas/GroupedWithMinMaxThresholdsPrice",
"grouped_with_prorated_minimum": "#/components/schemas/GroupedWithProratedMinimumPrice",
"matrix": "#/components/schemas/MatrixPrice",
"matrix_with_allocation": "#/components/schemas/MatrixWithAllocationPrice",
"matrix_with_display_name": "#/components/schemas/MatrixWithDisplayNamePrice",
"matrix_with_threshold_discounts": "#/components/schemas/MatrixWithThresholdDiscountsPrice",
"max_group_tiered_package": "#/components/schemas/MaxGroupTieredPackagePrice",
"metered_allowance": "#/components/schemas/MeteredAllowancePrice",
"minimum_composite": "#/components/schemas/MinimumCompositePrice",
"package": "#/components/schemas/PackagePrice",
"package_with_allocation": "#/components/schemas/PackageWithAllocationPrice",
"percent": "#/components/schemas/PercentCompositePrice",
"scalable_matrix_with_tiered_pricing": "#/components/schemas/ScalableMatrixWithTieredPricingPrice",
"scalable_matrix_with_unit_pricing": "#/components/schemas/ScalableMatrixWithUnitPricingPrice",
"threshold_total_amount": "#/components/schemas/ThresholdTotalAmountPrice",
"tiered": "#/components/schemas/TieredPrice",
"tiered_package": "#/components/schemas/TieredPackagePrice",
"tiered_package_with_minimum": "#/components/schemas/TieredPackageWithMinimumPrice",
"tiered_with_minimum": "#/components/schemas/TieredWithMinimumPrice",
"tiered_with_proration": "#/components/schemas/TieredWithProrationPrice",
"unit": "#/components/schemas/UnitPrice",
"unit_with_percent": "#/components/schemas/UnitWithPercentPrice",
"unit_with_proration": "#/components/schemas/UnitWithProrationPrice"
}
}
},
"PriceEvaluationRequest": {
"properties": {
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The ID of a price to evaluate that exists in your Orb account."
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewFloatingPrice"
},
{
"type": "null"
}
],
"description": "An inline price definition to evaluate, allowing you to test price configurations before adding them to Orb."
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external ID of a price to evaluate that exists in your Orb account."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "A boolean [computed property](/extensibility/advanced-metrics#computed-properties) used to filter the underlying billable metric",
"examples": [
"my_numeric_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"grouping_keys": {
"items": {
"type": "string"
},
"type": "array",
"title": "Grouping Keys",
"description": "Properties (or [computed properties](/extensibility/advanced-metrics#computed-properties)) used to group the underlying billable metric",
"default": [],
"examples": [
[
"case when my_event_type = 'foo' then true else false end"
],
[
"hour_floor_timestamp_millis(timestamp_millis)",
"my_property"
]
]
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Optional overrides for parameterized billable metric parameters. If the metric has parameter definitions and no overrides are provided, defaults will be used."
}
},
"type": "object",
"title": "PriceEvaluationRequest"
},
"PriceFilter": {
"properties": {
"field": {
"type": "string",
"enum": [
"price_id",
"item_id",
"price_type",
"currency",
"pricing_unit_id"
],
"title": "Field",
"description": "The property of the price to filter on."
},
"operator": {
"type": "string",
"enum": [
"includes",
"excludes"
],
"title": "Operator",
"description": "Should prices that match the filter be included or excluded."
},
"values": {
"items": {
"type": "string"
},
"type": "array",
"uniqueItems": true,
"title": "Values",
"description": "The IDs or values that match this filter."
}
},
"type": "object",
"required": [
"field",
"operator",
"values"
],
"title": "PriceFilter"
},
"PriceGroup": {
"properties": {
"grouping_key": {
"type": "string",
"title": "Grouping Key",
"description": "Grouping key to break down a single price's costs"
},
"grouping_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Grouping Value"
},
"secondary_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secondary Grouping Key",
"description": "If the price is a matrix price, this is the second dimension key"
},
"secondary_grouping_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Secondary Grouping Value"
},
"quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Quantity",
"description": "The price's quantity for the group"
},
"total": {
"type": "string",
"title": "Total",
"description": "Total costs for this group for the timeframe. Note that this does not account for any minimums or discounts."
}
},
"type": "object",
"required": [
"grouping_key",
"grouping_value",
"secondary_grouping_key",
"secondary_grouping_value",
"total"
],
"title": "PriceGroup"
},
"PriceInterval": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the price interval. This is the date that Orb starts billing for this price."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the price interval. This is the date that Orb stops billing for this price."
},
"price": {
"$ref": "#/components/schemas/Price"
},
"billing_cycle_day": {
"type": "integer",
"title": "Billing Cycle Day",
"description": "The day of the month that Orb bills for this price"
},
"can_defer_billing": {
"type": "boolean",
"title": "Can Defer Billing",
"description": "For in-arrears prices. If true, and the price interval ends mid-cycle, the final line item will be deferred to the next scheduled invoice instead of being billed mid-cycle."
},
"fixed_fee_quantity_transitions": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/FixedFeeQuantityTransition"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Fixed Fee Quantity Transitions",
"description": "The fixed fee quantity transitions for this price interval. This is only relevant for fixed fees."
},
"current_billing_period_start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period Start Date",
"description": "The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if this price interval is not currently active."
},
"current_billing_period_end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period End Date",
"description": "The end of the current billing period. This is an exclusive timestamp, such that the instant returned is exactly the end of the billing period. Set to null if this price interval is not currently active."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter to apply to usage queries."
},
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer IDs whose usage events will be aggregated and billed under this price interval."
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Override values for parameterized billable metric variables. Keys are parameter names, values are the override values."
}
},
"type": "object",
"required": [
"id",
"start_date",
"end_date",
"price",
"billing_cycle_day",
"can_defer_billing",
"fixed_fee_quantity_transitions",
"current_billing_period_start_date",
"current_billing_period_end_date",
"filter",
"usage_customer_ids"
],
"title": "PriceInterval",
"description": "The Price Interval resource represents a period of time for which a price will bill on a subscription. A\nsubscription\u2019s price intervals define its billing behavior."
},
"PriceIntervalFixedFeeQuantityTransitionParams": {
"properties": {
"quantity": {
"type": "integer",
"title": "Quantity",
"description": "The quantity of the fixed fee quantity transition.",
"examples": [
5
]
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
}
],
"title": "Effective Date",
"description": "The date that the fixed fee quantity transition should take effect.",
"examples": [
"2023-05-01"
]
}
},
"type": "object",
"required": [
"quantity",
"effective_date"
],
"title": "PriceIntervalFixedFeeQuantityTransitionParams"
},
"Prices": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Price"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Prices"
},
"Product": {
"properties": {
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
}
},
"type": "object",
"required": [
"created_at",
"id",
"name"
],
"title": "Product"
},
"QuantityOnlyOverridePrice": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"description": "The subscription's override minimum amount for the plan.",
"examples": [
"1.23"
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"description": "The subscription's override maximum amount for the plan.",
"examples": [
"1.23"
]
},
"currency": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Currency",
"description": "The currency of the price. If not provided, the currency of the plan will be used."
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate",
"description": "The per unit conversion rate of the price currency to the invoicing currency."
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/DiscountOverride"
},
{
"type": "null"
}
],
"description": "The subscription's override discount for the plan."
},
"fixed_price_quantity": {
"type": "number",
"title": "Fixed Price Quantity",
"description": "The starting quantity of the price, if the price is a fixed price.",
"examples": [
2
]
}
},
"type": "object",
"required": [
"id",
"fixed_price_quantity"
],
"title": "QuantityOnlyOverridePrice"
},
"RedeemCouponParams": {
"properties": {
"coupon_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Coupon Id",
"description": "Coupon ID to be redeemed for this subscription."
},
"coupon_redemption_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Coupon Redemption Code",
"description": "Redemption code of the coupon to be redeemed for this subscription."
},
"change_option": {
"type": "string",
"enum": [
"requested_date",
"end_of_subscription_term",
"immediate"
],
"title": "Change Option"
},
"change_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Change Date",
"description": "The date that the coupon discount should take effect. This parameter can only be passed if the `change_option` is `requested_date`.",
"examples": [
"2017-07-21T17:32:28Z",
"2017-07-21"
]
},
"allow_invoice_credit_or_void": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Invoice Credit Or Void",
"description": "If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"required": [
"change_option"
],
"title": "RedeemCouponParams"
},
"RemovePlanAdjustmentParams": {
"properties": {
"adjustment_id": {
"type": "string",
"title": "Adjustment Id",
"description": "The id of the adjustment to remove from on the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to remove this adjustment from."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"adjustment_id"
],
"title": "RemovePlanAdjustmentParams"
},
"RemovePlanPriceParams": {
"properties": {
"price_id": {
"type": "string",
"title": "Price Id",
"description": "The id of the price to remove from the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to remove this price from."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"price_id"
],
"title": "RemovePlanPriceParams"
},
"RemoveSubscriptionAdjustmentParams": {
"properties": {
"adjustment_id": {
"type": "string",
"title": "Adjustment Id",
"description": "The id of the adjustment to remove on the subscription.",
"examples": [
"h74gfhdjvn7ujokd"
]
}
},
"type": "object",
"required": [
"adjustment_id"
],
"title": "RemoveSubscriptionAdjustmentParams"
},
"RemoveSubscriptionPriceParams": {
"properties": {
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The id of the price to remove on the subscription.",
"examples": [
"h74gfhdjvn7ujokd"
]
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external price id of the price to remove on the subscription.",
"examples": [
"external_price_id"
]
}
},
"type": "object",
"title": "RemoveSubscriptionPriceParams"
},
"ReplacePlanAdjustmentParams": {
"properties": {
"adjustment": {
"$ref": "#/components/schemas/NewAdjustment",
"description": "The definition of a new adjustment to create and add to the plan."
},
"replaces_adjustment_id": {
"type": "string",
"title": "Replaces Adjustment Id",
"description": "The id of the adjustment on the plan to replace in the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to replace this adjustment from."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"adjustment",
"replaces_adjustment_id"
],
"title": "ReplacePlanAdjustmentParams"
},
"ReplacePlanPriceParams": {
"properties": {
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewPlanPrice"
},
{
"type": "null"
}
],
"description": "The price to add to the plan"
},
"allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAllocationPrice"
},
{
"type": "null"
}
],
"description": "The allocation price to add to the plan."
},
"license_allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewLicenseAllocationPrice"
},
{
"type": "null"
}
],
"description": "The license allocation price to add to the plan."
},
"replaces_price_id": {
"type": "string",
"title": "Replaces Price Id",
"description": "The id of the price on the plan to replace in the plan."
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order",
"description": "The phase to replace this price from."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"replaces_price_id"
],
"title": "ReplacePlanPriceParams"
},
"ReplaceSubscriptionAdjustmentParams": {
"properties": {
"adjustment": {
"$ref": "#/components/schemas/NewAdjustment",
"description": "The definition of a new adjustment to create and add to the subscription."
},
"replaces_adjustment_id": {
"type": "string",
"title": "Replaces Adjustment Id",
"description": "The id of the adjustment on the plan to replace in the subscription."
}
},
"type": "object",
"required": [
"adjustment",
"replaces_adjustment_id"
],
"title": "ReplaceSubscriptionAdjustmentParams"
},
"ReplaceSubscriptionPriceParams": {
"properties": {
"price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Price Id",
"description": "The id of the price to add to the subscription.",
"examples": [
"h74gfhdjvn7ujokd"
]
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id",
"description": "The external price id of the price to add to the subscription.",
"examples": [
"external_price_id"
]
},
"price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewSubscriptionPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new price to create and add to the subscription."
},
"allocation_price": {
"oneOf": [
{
"$ref": "#/components/schemas/NewAllocationPrice"
},
{
"type": "null"
}
],
"description": "The definition of a new allocation price to create and add to the subscription."
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity",
"description": "The new quantity of the price, if the price is a fixed price.",
"examples": [
2
]
},
"replaces_price_id": {
"type": "string",
"title": "Replaces Price Id",
"description": "The id of the price on the plan to replace in the subscription."
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's minimum amount for the replacement price.",
"deprecated": true,
"examples": [
"1.23"
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's maximum amount for the replacement price.",
"deprecated": true,
"examples": [
"1.23"
]
},
"discounts": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/DiscountOverride"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Discounts",
"description": "[DEPRECATED] Use add_adjustments instead. The subscription's discounts for the replacement price.",
"deprecated": true
},
"metric_parameter_overrides": {
"oneOf": [
{
"additionalProperties": true,
"type": "object"
},
{
"type": "null"
}
],
"title": "Metric Parameter Overrides",
"description": "Override values for parameterized billable metric variables. Keys are parameter names, values are the override values."
}
},
"type": "object",
"required": [
"replaces_price_id"
],
"title": "ReplaceSubscriptionPriceParams"
},
"ReportingConfiguration": {
"properties": {
"exempt": {
"type": "boolean",
"title": "Exempt"
}
},
"type": "object",
"required": [
"exempt"
],
"title": "ReportingConfiguration"
},
"RequestTooLargeError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#413-request-too-large"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
413
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "RequestTooLargeError"
},
"RequestValidationError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#400-request-validation-errors"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
400
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
},
"validation_errors": {
"items": {},
"type": "array",
"title": "Validation Errors"
}
},
"type": "object",
"required": [
"type",
"status",
"validation_errors"
],
"title": "RequestValidationError"
},
"ResourceNotFoundError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#404-resource-not-found"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
404
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"type": "string",
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status",
"title"
],
"title": "ResourceNotFoundError"
},
"ResourceTooLargeError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#413-resource-too-large"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
413
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "ResourceTooLargeError"
},
"ScalableMatrixWithTieredPricingConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredTierEntry"
},
"type": "array",
"minItems": 2,
"title": "Tiers"
},
"first_dimension": {
"type": "string",
"title": "First Dimension",
"description": "Used for the scalable matrix first dimension"
},
"second_dimension": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension",
"description": "Used for the scalable matrix second dimension (optional)"
},
"matrix_scaling_factors": {
"items": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredScalingFactor"
},
"type": "array",
"minItems": 1,
"title": "Matrix Scaling Factors",
"description": "Apply a scaling factor to each dimension"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"first_dimension",
"matrix_scaling_factors"
],
"title": "ScalableMatrixWithTieredPricingConfig",
"description": "Configuration for scalable matrix with tiered pricing"
},
"ScalableMatrixWithTieredPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_tiered_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_tiered_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithTieredPricingConfig",
"description": "Configuration for scalable_matrix_with_tiered_pricing pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_tiered_pricing_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "ScalableMatrixWithTieredPricingPrice"
},
"ScalableMatrixWithTieredScalingFactor": {
"properties": {
"first_dimension_value": {
"type": "string",
"title": "First Dimension Value"
},
"second_dimension_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Value"
},
"scaling_factor": {
"type": "string",
"title": "Scaling Factor"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_dimension_value",
"scaling_factor"
],
"title": "ScalableMatrixWithTieredScalingFactor",
"description": "Configuration for a single matrix scaling factor"
},
"ScalableMatrixWithTieredTierEntry": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"unit_amount"
],
"title": "ScalableMatrixWithTieredTierEntry",
"description": "Configuration for a single tier entry with business logic"
},
"ScalableMatrixWithUnitPricingConfig": {
"properties": {
"grouping_key": {
"oneOf": [
{
"type": "string",
"minLength": 1
},
{
"type": "null"
}
],
"title": "Grouping Key",
"description": "The property used to group this price"
},
"unit_price": {
"type": "string",
"title": "Unit Price",
"description": "The final unit price to rate against the output of the matrix"
},
"first_dimension": {
"type": "string",
"title": "First Dimension",
"description": "Used to determine the unit rate"
},
"second_dimension": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension",
"description": "Used to determine the unit rate (optional)"
},
"matrix_scaling_factors": {
"items": {
"$ref": "#/components/schemas/ScalableMatrixWithUnitScalingFactor"
},
"type": "array",
"minItems": 1,
"title": "Matrix Scaling Factors",
"description": "Apply a scaling factor to each dimension"
},
"prorate": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Prorate",
"description": "If true, the unit price will be prorated to the billing period",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_price",
"first_dimension",
"matrix_scaling_factors"
],
"title": "ScalableMatrixWithUnitPricingConfig",
"description": "Configuration for scalable matrix with unit pricing"
},
"ScalableMatrixWithUnitPricingPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"scalable_matrix_with_unit_pricing"
],
"title": "Model Type",
"description": "The pricing model type"
},
"scalable_matrix_with_unit_pricing_config": {
"$ref": "#/components/schemas/ScalableMatrixWithUnitPricingConfig",
"description": "Configuration for scalable_matrix_with_unit_pricing pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"scalable_matrix_with_unit_pricing_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "ScalableMatrixWithUnitPricingPrice"
},
"ScalableMatrixWithUnitScalingFactor": {
"properties": {
"first_dimension_value": {
"type": "string",
"title": "First Dimension Value"
},
"second_dimension_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Value"
},
"scaling_factor": {
"type": "string",
"title": "Scaling Factor"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_dimension_value",
"scaling_factor"
],
"title": "ScalableMatrixWithUnitScalingFactor",
"description": "Configuration for a single matrix scaling factor"
},
"ServerError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#500-internal-server-error"
],
"title": "Type"
},
"status": {
"type": "integer",
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "ServerError"
},
"SetDefaultVersion": {
"properties": {
"version": {
"type": "integer",
"title": "Version",
"description": "Plan version to set as the default."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"version"
],
"title": "SetDefaultVersion"
},
"SubLineItemGrouping": {
"properties": {
"key": {
"type": "string",
"title": "Key",
"examples": [
"region"
]
},
"value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Value",
"description": "No value indicates the default group",
"examples": [
"west"
]
}
},
"type": "object",
"required": [
"key",
"value"
],
"title": "SubLineItemGrouping"
},
"SubLineItemMatrixConfig": {
"properties": {
"dimension_values": {
"items": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "array",
"title": "Dimension Values",
"description": "The ordered dimension values for this line item."
}
},
"type": "object",
"required": [
"dimension_values"
],
"title": "SubLineItemMatrixConfig"
},
"Subscription": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"customer": {
"$ref": "#/components/schemas/Customer"
},
"plan": {
"oneOf": [
{
"$ref": "#/components/schemas/Plan"
},
{
"type": "null"
}
]
},
"name": {
"type": "string",
"title": "Name",
"description": "The name of the subscription."
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The date Orb starts billing for this subscription."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The date Orb stops billing for this subscription."
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"current_billing_period_start_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period Start Date",
"description": "The start date of the current billing period. This is an inclusive timestamp; the instant returned is exactly the beginning of the billing period. Set to null if the subscription is not currently active."
},
"current_billing_period_end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Current Billing Period End Date",
"description": "The end of the current billing period. This is an exclusive timestamp, such that the instant returned is not part of the billing period. Set to null for subscriptions that are not currently active."
},
"status": {
"type": "string",
"enum": [
"active",
"ended",
"upcoming"
],
"title": "Status"
},
"trial_info": {
"$ref": "#/components/schemas/SubscriptionTrialInfo"
},
"active_plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Active Plan Phase Order",
"description": "The current plan phase that is active, only if the subscription's plan has phases."
},
"fixed_fee_quantity_schedule": {
"items": {
"$ref": "#/components/schemas/FixedFeeQuantityScheduleEntry"
},
"type": "array",
"title": "Fixed Fee Quantity Schedule"
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Determines the default memo on this subscriptions' invoices. Note that if this is not provided, it is determined by the plan configuration."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior. If null, defaults to the customer's setting."
},
"net_terms": {
"type": "integer",
"title": "Net Terms",
"description": "Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of `0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice."
},
"redeemed_coupon": {
"oneOf": [
{
"$ref": "#/components/schemas/CouponRedemption"
},
{
"type": "null"
}
]
},
"billing_cycle_day": {
"type": "integer",
"maximum": 31.0,
"minimum": 1.0,
"title": "Billing Cycle Day",
"description": "The day of the month on which the billing cycle is anchored. If the maximum number of days in a month is greater than this value, the last day of the month is the billing cycle day (e.g. billing_cycle_day=31 for April means the billing period begins on the 30th."
},
"billing_cycle_anchor_configuration": {
"$ref": "#/components/schemas/BillingCycleAnchorConfiguration"
},
"invoicing_threshold": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoicing Threshold"
},
"price_intervals": {
"items": {
"$ref": "#/components/schemas/PriceInterval"
},
"type": "array",
"title": "Price Intervals",
"description": "The price intervals for this subscription."
},
"adjustment_intervals": {
"items": {
"$ref": "#/components/schemas/AdjustmentInterval"
},
"type": "array",
"title": "Adjustment Intervals",
"description": "The adjustment intervals for this subscription sorted by the start_date of the adjustment interval."
},
"discount_intervals": {
"items": {
"oneOf": [
{
"$ref": "#/components/schemas/AmountDiscountInterval"
},
{
"$ref": "#/components/schemas/PercentageDiscountInterval"
},
{
"$ref": "#/components/schemas/UsageDiscountInterval"
}
],
"discriminator": {
"propertyName": "discount_type",
"mapping": {
"amount": "#/components/schemas/AmountDiscountInterval",
"percentage": "#/components/schemas/PercentageDiscountInterval",
"usage": "#/components/schemas/UsageDiscountInterval"
}
}
},
"type": "array",
"title": "Discount Intervals",
"description": "The discount intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"minimum_intervals": {
"items": {
"$ref": "#/components/schemas/MinimumInterval"
},
"type": "array",
"title": "Minimum Intervals",
"description": "The minimum intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"maximum_intervals": {
"items": {
"$ref": "#/components/schemas/MaximumInterval"
},
"type": "array",
"title": "Maximum Intervals",
"description": "The maximum intervals for this subscription sorted by the start_date. This field is deprecated in favor of `adjustment_intervals`.",
"deprecated": true
},
"pending_subscription_change": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionChangeMinified"
},
{
"type": "null"
}
],
"description": "A pending subscription change if one exists on this subscription."
}
},
"type": "object",
"required": [
"metadata",
"id",
"customer",
"plan",
"name",
"start_date",
"end_date",
"created_at",
"current_billing_period_start_date",
"current_billing_period_end_date",
"status",
"trial_info",
"active_plan_phase_order",
"fixed_fee_quantity_schedule",
"default_invoice_memo",
"auto_collection",
"net_terms",
"redeemed_coupon",
"billing_cycle_day",
"billing_cycle_anchor_configuration",
"invoicing_threshold",
"price_intervals",
"adjustment_intervals",
"discount_intervals",
"minimum_intervals",
"maximum_intervals",
"pending_subscription_change"
],
"title": "Subscription",
"description": "A [subscription](/core-concepts#subscription) represents the purchase of a plan by a customer.\n\nBy default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at\nthe cadence that's configured in the plan definition.\n\nSubscriptions also default to **beginning of month alignment**, which means the first invoice issued for the\nsubscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent\nbilling periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing).\n\nDepending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)\nor end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in\narrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based\ncharges for the previous period, and a recurring fee for the following period."
},
"SubscriptionChangeListResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"status": {
"type": "string",
"enum": [
"pending",
"applied",
"cancelled"
],
"title": "Status"
},
"applied_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Applied At",
"description": "When this change was applied."
},
"cancelled_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cancelled At",
"description": "When this change was cancelled."
},
"expiration_time": {
"type": "string",
"format": "date-time",
"title": "Expiration Time",
"description": "Subscription change will be cancelled at this time and can no longer be applied."
},
"subscription_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id"
}
},
"type": "object",
"required": [
"id",
"status",
"expiration_time",
"subscription_id"
],
"title": "SubscriptionChangeListResponse"
},
"SubscriptionChangeListResponses": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SubscriptionChangeListResponse"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "SubscriptionChangeListResponses"
},
"SubscriptionChangeMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id"
}
},
"type": "object",
"required": [
"id"
],
"title": "SubscriptionChangeMinified"
},
"SubscriptionChangeResponse": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"status": {
"type": "string",
"enum": [
"pending",
"applied",
"cancelled"
],
"title": "Status"
},
"applied_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Applied At",
"description": "When this change was applied."
},
"cancelled_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Cancelled At",
"description": "When this change was cancelled."
},
"expiration_time": {
"type": "string",
"format": "date-time",
"title": "Expiration Time",
"description": "Subscription change will be cancelled at this time and can no longer be applied."
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/MutatedSubscription"
},
{
"type": "null"
}
]
},
"change_type": {
"type": "string",
"title": "Change Type",
"description": "The type of change (e.g., 'schedule_plan_change', 'create_subscription')."
},
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Effective Date",
"description": "When this change will take effect."
},
"change_option": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Change Option",
"description": "How the change is scheduled (e.g., 'immediate', 'end_of_subscription_term', 'requested_date')."
},
"plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Id",
"description": "The target plan ID for plan changes."
},
"billing_cycle_alignment": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billing Cycle Alignment",
"description": "Billing cycle alignment for plan changes."
}
},
"type": "object",
"required": [
"id",
"status",
"expiration_time",
"subscription",
"change_type"
],
"title": "SubscriptionChangeResponse",
"description": "A subscription change represents a desired new subscription / pending change to an existing subscription. It\nis a way to first preview the effects on the subscription as well as any changes/creation of invoices\n(see `subscription.changed_resources`)."
},
"SubscriptionCosts": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/AggregatedCost"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "SubscriptionCosts"
},
"SubscriptionMinified": {
"properties": {
"id": {
"type": "string",
"title": "Id",
"examples": [
"VDGsT23osdLb84KD"
]
}
},
"type": "object",
"required": [
"id"
],
"title": "SubscriptionMinified"
},
"SubscriptionPlanChange": {
"properties": {
"usage_customer_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Usage Customer Ids",
"description": "A list of customer IDs whose usage events will be aggregated and billed under this subscription. By default, a subscription only considers usage events associated with its attached customer's customer_id. When usage_customer_ids is provided, the subscription includes usage events from the specified customers only. Provided usage_customer_ids must be either the customer for this subscription itself, or any of that customer's children."
},
"filter": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Filter",
"description": "An additional filter to apply to usage queries. This filter must be expressed as a boolean [computed property](/extensibility/advanced-metrics#computed-properties). If null, usage queries will not include any additional filter.",
"examples": [
"my_property > 100 AND my_other_property = 'bar'",
"my_property = 'foo'"
]
},
"plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Plan Id",
"description": "The plan that the given subscription should be switched to. Note that either this property or `external_plan_id` must be specified.",
"examples": [
"ZMwNQefe7J3ecf7W"
]
},
"external_plan_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Plan Id",
"description": "The external_plan_id of the plan that the given subscription should be switched to. Note that either this property or `plan_id` must be specified.",
"examples": [
"ZMwNQefe7J3ecf7W"
]
},
"price_overrides": {
"oneOf": [
{
"items": {
"deprecated": true
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Price Overrides",
"description": "Optionally provide a list of overrides for prices on the plan",
"deprecated": true
},
"per_credit_overage_amount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Per Credit Overage Amount",
"deprecated": true
},
"credits_overage_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Credits Overage Rate",
"deprecated": true
},
"trial_duration_days": {
"oneOf": [
{
"type": "integer",
"exclusiveMaximum": 1000000.0,
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Trial Duration Days",
"description": "The duration of the trial period in days. If not provided, this defaults to the value specified in the plan. If `0` is provided, the trial on the plan will be skipped."
},
"net_terms": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0. If not provided, this defaults to the value specified in the plan."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. If not specified, this defaults to the behavior configured for this customer."
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Determines the default memo on this subscription's invoices. Note that if this is not provided, it is determined by the plan configuration."
},
"coupon_redemption_code": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Coupon Redemption Code",
"description": "Redemption code to be used for this subscription. If the coupon cannot be found by its redemption code, or cannot be redeemed, an error response will be returned and the subscription creation or plan change will not be scheduled."
},
"invoicing_threshold": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoicing Threshold",
"description": "When this subscription's accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.",
"examples": [
"10.00"
]
},
"initial_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Initial Phase Order",
"description": "The phase of the plan to start with",
"examples": [
2
]
},
"add_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Prices",
"description": "Additional prices to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"remove_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemoveSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Prices",
"description": "Plan prices to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"replace_prices": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplaceSubscriptionPriceParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Prices",
"description": "Plan prices to be replaced with additional prices on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"add_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/AddSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Add Adjustments",
"description": "Additional adjustments to be added to the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"remove_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/RemoveSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Remove Adjustments",
"description": "Plan adjustments to be removed from the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"replace_adjustments": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/ReplaceSubscriptionAdjustmentParams"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Replace Adjustments",
"description": "Plan adjustments to be replaced with additional adjustments on the subscription. (Only available for accounts that have migrated off of legacy subscription overrides)"
},
"change_option": {
"type": "string",
"enum": [
"requested_date",
"end_of_subscription_term",
"immediate"
],
"title": "Change Option"
},
"change_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Change Date",
"description": "The date that the plan change should take effect. This parameter can only be passed if the `change_option` is `requested_date`. If a date with no time is passed, the plan change will happen at midnight in the customer's timezone.",
"examples": [
"2017-07-21T17:32:28Z",
"2017-07-21"
]
},
"align_billing_with_plan_change_date": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Align Billing With Plan Change Date",
"description": "[DEPRECATED] Use billing_cycle_alignment instead. Reset billing periods to be aligned with the plan change's effective date."
},
"billing_cycle_alignment": {
"oneOf": [
{
"type": "string",
"enum": [
"unchanged",
"plan_change_date",
"start_of_month"
]
},
{
"type": "null"
}
],
"title": "Billing Cycle Alignment",
"description": "Reset billing periods to be aligned with the plan change's effective date or start of the month. Defaults to `unchanged` which keeps subscription's existing billing cycle alignment.",
"default": "unchanged"
},
"plan_version_number": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Version Number",
"description": "Specifies which version of the plan to change to. If null, the default version will be used."
},
"billing_cycle_anchor_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleAnchorConfiguration"
},
{
"type": "null"
}
]
}
},
"additionalProperties": false,
"type": "object",
"required": [
"change_option"
],
"title": "SubscriptionPlanChange"
},
"SubscriptionScheduleItem": {
"properties": {
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date"
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"plan": {
"oneOf": [
{
"$ref": "#/components/schemas/PlanMinified"
},
{
"type": "null"
}
]
}
},
"type": "object",
"required": [
"start_date",
"end_date",
"created_at",
"plan"
],
"title": "SubscriptionScheduleItem"
},
"SubscriptionScheduleItems": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/SubscriptionScheduleItem"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "SubscriptionScheduleItems"
},
"SubscriptionTrialInfo": {
"properties": {
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date"
}
},
"type": "object",
"required": [
"end_date"
],
"title": "SubscriptionTrialInfo"
},
"SubscriptionUsage": {
"oneOf": [
{
"$ref": "#/components/schemas/UngroupedSubscriptionUsage"
},
{
"$ref": "#/components/schemas/GroupedSubscriptionUsage"
}
]
},
"SubscriptionUsageRequestParams": {
"properties": {
"granularity": {
"oneOf": [
{
"type": "string",
"enum": [
"day"
]
},
{
"type": "null"
}
],
"title": "Granularity",
"description": "This determines the windowing of usage reporting.",
"default": "day"
},
"timeframe_start": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe Start",
"description": "Usage returned is inclusive of `timeframe_start`.",
"examples": [
"2022-02-01T05:00:00Z"
]
},
"timeframe_end": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Timeframe End",
"description": "Usage returned is exclusive of `timeframe_end`.",
"examples": [
"2022-03-01T05:00:00Z"
]
},
"billable_metric_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Billable Metric Id",
"description": "When specified in conjunction with `group_by`, this parameter filters usage to a single billable metric. Note that both `group_by` and `billable_metric_id` must be specified together."
},
"group_by": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Group By",
"description": "Groups per-price usage by the key provided."
},
"view_mode": {
"oneOf": [
{
"type": "string",
"enum": [
"periodic",
"cumulative"
]
},
{
"type": "null"
}
],
"title": "View Mode",
"description": "Controls whether Orb returns cumulative usage since the start of the billing period, or incremental day-by-day usage. If your customer has minimums or discounts, it's strongly recommended that you use the default cumulative behavior."
},
"first_dimension_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Dimension Key"
},
"first_dimension_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "First Dimension Value"
},
"second_dimension_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Key"
},
"second_dimension_value": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Second Dimension Value"
}
},
"additionalProperties": false,
"type": "object",
"title": "SubscriptionUsageRequestParams"
},
"Subscriptions": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/Subscription"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "Subscriptions"
},
"TaxAmount": {
"properties": {
"tax_rate_description": {
"type": "string",
"title": "Tax Rate Description",
"description": "The human-readable description of the applied tax rate."
},
"tax_rate_percentage": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Tax Rate Percentage",
"description": "The tax rate percentage, out of 100."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount of additional tax incurred by this tax rate."
}
},
"type": "object",
"required": [
"tax_rate_description",
"tax_rate_percentage",
"amount"
],
"title": "TaxAmount"
},
"Threshold": {
"properties": {
"value": {
"type": "number",
"title": "Value",
"description": "The value at which an alert will fire. For credit balance alerts, the alert will fire at or below this value. For usage and cost alerts, the alert will fire at or above this value."
}
},
"type": "object",
"required": [
"value"
],
"title": "Threshold",
"description": "Thresholds are used to define the conditions under which an alert will be triggered."
},
"ThresholdDiscountGroup": {
"properties": {
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"cell_coordinates": {
"type": "string",
"title": "Cell Coordinates",
"description": "Semicolon-separated list of matrix cell coordinates targeted by this group. Each coordinate is `first,second` when the matrix has two dimensions, or just `first` for a single-dimension matrix. Example: `blue,circle;green,triangle`."
},
"threshold_amount": {
"type": "string",
"title": "Threshold Amount"
},
"below_threshold_discount_percentage": {
"type": "string",
"title": "Below Threshold Discount Percentage",
"description": "Discount rate applied to spend at or below the threshold. Set to 0 for no baseline discount."
},
"above_threshold_discount_percentage": {
"type": "string",
"title": "Above Threshold Discount Percentage",
"description": "Discount rate applied to spend above the threshold."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"cell_coordinates",
"threshold_amount",
"below_threshold_discount_percentage",
"above_threshold_discount_percentage"
],
"title": "ThresholdDiscountGroup"
},
"ThresholdOverride": {
"properties": {
"group_values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Group Values",
"description": "The values of the grouping keys that identify this group. The list length matches the alert's grouping_keys."
},
"thresholds": {
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array",
"title": "Thresholds",
"description": "The thresholds applied to this group. An empty list means the group is silenced."
}
},
"type": "object",
"required": [
"group_values",
"thresholds"
],
"title": "ThresholdOverride",
"description": "A per-group threshold override on a grouped cost alert.\n\nAn empty `thresholds` list means the group is silenced (never fires).\nA non-empty list fully replaces the default thresholds for that group."
},
"ThresholdOverrideParams": {
"properties": {
"group_values": {
"items": {
"type": "string"
},
"type": "array",
"title": "Group Values",
"description": "The values of the grouping keys that identify this group. The list length must match the alert's grouping_keys, and values appear in the same order as grouping_keys."
},
"thresholds": {
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array",
"title": "Thresholds",
"description": "The thresholds to apply to this group. An empty list silences alerts for this group. A non-empty list fully replaces the default thresholds for this group."
}
},
"type": "object",
"required": [
"group_values",
"thresholds"
],
"title": "ThresholdOverrideParams",
"description": "Per-group threshold override on a grouped cost alert.\n\n- An empty `thresholds` list silences alerts for this group (never fires).\n- A non-empty list fully replaces the default thresholds for this group."
},
"ThresholdTotalAmountConfig": {
"properties": {
"consumption_table": {
"items": {
"$ref": "#/components/schemas/TieredTotalThreshold"
},
"type": "array",
"minItems": 2,
"title": "Consumption Table",
"description": "When the quantity consumed passes a provided threshold, the configured total will be charged"
},
"prorate": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Prorate",
"description": "If true, the unit price will be prorated to the billing period",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"consumption_table"
],
"title": "ThresholdTotalAmountConfig",
"description": "Configuration for tiered total pricing"
},
"ThresholdTotalAmountPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"threshold_total_amount"
],
"title": "Model Type",
"description": "The pricing model type"
},
"threshold_total_amount_config": {
"$ref": "#/components/schemas/ThresholdTotalAmountConfig",
"description": "Configuration for threshold_total_amount pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"threshold_total_amount_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "ThresholdTotalAmountPrice"
},
"Tier": {
"properties": {
"first_unit": {
"type": "number",
"title": "First Unit",
"description": "Exclusive tier starting value"
},
"last_unit": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Last Unit",
"description": "Inclusive tier ending value. This value is null if and only if this is the last tier."
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"first_unit",
"unit_amount"
],
"title": "Tier",
"description": "Configuration for a single tier"
},
"TierSubLineItem": {
"properties": {
"amount": {
"type": "string",
"title": "Amount",
"description": "The total amount for this sub line item.",
"examples": [
"9.00"
]
},
"name": {
"type": "string",
"title": "Name",
"examples": [
"Tier One"
]
},
"quantity": {
"type": "number",
"title": "Quantity",
"examples": [
5
]
},
"grouping": {
"oneOf": [
{
"$ref": "#/components/schemas/SubLineItemGrouping"
},
{
"type": "null"
}
]
},
"type": {
"type": "string",
"enum": [
"tier"
],
"title": "Type"
},
"tier_config": {
"$ref": "#/components/schemas/TierSubLineItemTierConfig"
}
},
"type": "object",
"required": [
"amount",
"name",
"quantity",
"grouping",
"type",
"tier_config"
],
"title": "TierSubLineItem"
},
"TierSubLineItemTierConfig": {
"properties": {
"first_unit": {
"type": "number",
"title": "First Unit",
"examples": [
1
]
},
"last_unit": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Last Unit",
"examples": [
1000
]
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"examples": [
"3.00"
]
}
},
"type": "object",
"required": [
"first_unit",
"last_unit",
"unit_amount"
],
"title": "TierSubLineItemTierConfig"
},
"TieredConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/Tier"
},
"type": "array",
"minItems": 1,
"title": "Tiers",
"description": "Tiers for rating based on total usage quantities into the specified tier"
},
"prorated": {
"type": "boolean",
"title": "Prorated",
"description": "If true, subtotals from this price are prorated based on the service period",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "TieredConfig",
"description": "Configuration for tiered pricing"
},
"TieredConversionRateConfig": {
"properties": {
"conversion_rate_type": {
"type": "string",
"enum": [
"tiered"
],
"title": "Conversion Rate Type"
},
"tiered_config": {
"$ref": "#/components/schemas/ConversionRateTieredConfig"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"conversion_rate_type",
"tiered_config"
],
"title": "TieredConversionRateConfig"
},
"TieredPackagePrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_config": {
"$ref": "#/components/schemas/TieredPackagePricingConfig",
"description": "Configuration for tiered_package pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"tiered_package_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "TieredPackagePrice"
},
"TieredPackagePricingConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/TieredPackageTierItem"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds. The tier bounds are defined based on the total quantity rather than the number of packages, so they must be multiples of the package size."
},
"package_size": {
"type": "string",
"title": "Package Size"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"package_size"
],
"title": "TieredPackagePricingConfig",
"description": "Configuration for tiered package pricing"
},
"TieredPackagePricingWithMinimumConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/TieredPackageWithMinimumTierItem"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Apply tiered pricing after rounding up the quantity to the package size. Tiers are defined using exclusive lower bounds."
},
"package_size": {
"type": "number",
"title": "Package Size"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers",
"package_size"
],
"title": "TieredPackagePricingWithMinimumConfig",
"description": "Configuration for tiered package pricing with minimum"
},
"TieredPackageTierItem": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"per_unit": {
"type": "string",
"title": "Per Unit",
"description": "Price per package"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"per_unit"
],
"title": "TieredPackageTierItem",
"description": "Configuration for a single tier with business logic"
},
"TieredPackageWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_package_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_package_with_minimum_config": {
"$ref": "#/components/schemas/TieredPackagePricingWithMinimumConfig",
"description": "Configuration for tiered_package_with_minimum pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"tiered_package_with_minimum_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "TieredPackageWithMinimumPrice"
},
"TieredPackageWithMinimumTierItem": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"per_unit": {
"type": "string",
"title": "Per Unit"
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"per_unit",
"minimum_amount"
],
"title": "TieredPackageWithMinimumTierItem",
"description": "Configuration for a single tier"
},
"TieredPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_config": {
"$ref": "#/components/schemas/TieredConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"tiered_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "TieredPrice"
},
"TieredPricingWithMinimumConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/TieredPricingWithMinimumTierItem"
},
"type": "array",
"minItems": 2,
"title": "Tiers",
"description": "Tiered pricing with a minimum amount dependent on the volume tier. Tiers are defined using exclusive lower bounds."
},
"hide_zero_amount_tiers": {
"type": "boolean",
"title": "Hide Zero Amount Tiers",
"description": "If true, tiers with an accrued amount of 0 will not be included in the rating."
},
"prorate": {
"type": "boolean",
"title": "Prorate",
"description": "If true, the unit price will be prorated to the billing period"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "TieredPricingWithMinimumConfig",
"description": "Configuration for tiered pricing with minimum"
},
"TieredPricingWithMinimumTierItem": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Per unit amount"
},
"minimum_amount": {
"type": "string",
"title": "Minimum Amount"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"unit_amount",
"minimum_amount"
],
"title": "TieredPricingWithMinimumTierItem",
"description": "Configuration for a single tier"
},
"TieredTotalThreshold": {
"properties": {
"threshold": {
"type": "string",
"title": "Threshold"
},
"total_amount": {
"type": "string",
"title": "Total Amount",
"description": "Total amount for this threshold"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"threshold",
"total_amount"
],
"title": "TieredTotalThreshold",
"description": "Configuration for a single threshold"
},
"TieredWithMinimumPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_minimum"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_minimum_config": {
"$ref": "#/components/schemas/TieredPricingWithMinimumConfig",
"description": "Configuration for tiered_with_minimum pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"tiered_with_minimum_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "TieredWithMinimumPrice"
},
"TieredWithProrationConfig": {
"properties": {
"tiers": {
"items": {
"$ref": "#/components/schemas/TieredWithProrationTier"
},
"type": "array",
"minItems": 1,
"title": "Tiers",
"description": "Tiers for rating based on total usage quantities into the specified tier with proration"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tiers"
],
"title": "TieredWithProrationConfig",
"description": "Configuration for tiered pricing with proration"
},
"TieredWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"tiered_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"tiered_with_proration_config": {
"$ref": "#/components/schemas/TieredWithProrationConfig",
"description": "Configuration for tiered_with_proration pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"tiered_with_proration_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "TieredWithProrationPrice"
},
"TieredWithProrationTier": {
"properties": {
"tier_lower_bound": {
"type": "string",
"title": "Tier Lower Bound",
"description": "Inclusive tier starting value"
},
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Amount per unit"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"tier_lower_bound",
"unit_amount"
],
"title": "TieredWithProrationTier",
"description": "Configuration for a single tiered with proration tier"
},
"TooManyRequests": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#429-too-many-requests"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
429
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "TooManyRequests"
},
"TooManyResultsError": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#413-too-many-results"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
413
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "TooManyResultsError"
},
"TopUp": {
"properties": {
"id": {
"type": "string",
"title": "Id"
},
"currency": {
"type": "string",
"title": "Currency",
"description": "The currency or custom pricing unit to use for this top-up. If this is a real-world currency, it must match the customer's invoicing currency."
},
"threshold": {
"type": "string",
"title": "Threshold",
"description": "The threshold at which to trigger the top-up. If the balance is at or below this threshold, the top-up will be triggered."
},
"amount": {
"type": "string",
"title": "Amount",
"description": "The amount to increment when the threshold is reached."
},
"per_unit_cost_basis": {
"type": "string",
"title": "Per Unit Cost Basis",
"description": "How much, in the customer's currency, to charge for each unit."
},
"invoice_settings": {
"$ref": "#/components/schemas/TopUpInvoiceSettings",
"description": "Settings for invoices generated by triggered top-ups."
},
"expires_after": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Expires After",
"description": "The number of days or months after which the top-up expires. If unspecified, it does not expire."
},
"expires_after_unit": {
"oneOf": [
{
"type": "string",
"enum": [
"day",
"month"
]
},
{
"type": "null"
}
],
"title": "Expires After Unit",
"description": "The unit of expires_after."
}
},
"type": "object",
"required": [
"id",
"currency",
"threshold",
"amount",
"per_unit_cost_basis",
"invoice_settings"
],
"title": "TopUp"
},
"TopUpInvoiceSettings": {
"properties": {
"auto_collection": {
"type": "boolean",
"title": "Auto Collection",
"description": "Whether the credits purchase invoice should auto collect with the customer's saved payment method."
},
"net_terms": {
"type": "integer",
"title": "Net Terms",
"description": "The net terms determines the difference between the invoice date and the issue date for the invoice. If you intend the invoice to be due on issue, set this to 0."
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "An optional memo to display on the invoice."
},
"require_successful_payment": {
"type": "boolean",
"title": "Require Successful Payment",
"description": "When true, credit blocks created by this top-up will require that the corresponding invoice is paid before they are drawn down from. If any topup block is pending payment, further automatic top-ups will be paused until the invoice is paid or voided.",
"default": false
}
},
"type": "object",
"required": [
"auto_collection",
"net_terms"
],
"title": "TopUpInvoiceSettings"
},
"TopUps": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/TopUp"
},
"type": "array",
"title": "Data"
},
"pagination_metadata": {
"$ref": "#/components/schemas/PaginationMetadata"
}
},
"type": "object",
"required": [
"data",
"pagination_metadata"
],
"title": "TopUps"
},
"TrialConfig": {
"properties": {
"trial_period": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Trial Period"
},
"trial_period_unit": {
"type": "string",
"enum": [
"days"
],
"title": "Trial Period Unit"
}
},
"type": "object",
"required": [
"trial_period",
"trial_period_unit"
],
"title": "TrialConfig"
},
"TrialDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"trial"
],
"title": "Discount Type"
},
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.",
"examples": [
[
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
]
]
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "The filters that determine which prices to apply this discount to."
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"trial_amount_discount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Trial Amount Discount",
"description": "Only available if discount_type is `trial`"
},
"trial_percentage_discount": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Trial Percentage Discount",
"description": "Only available if discount_type is `trial`"
}
},
"type": "object",
"required": [
"discount_type"
],
"title": "TrialDiscount"
},
"TriggerSubscriptionPhaseParams": {
"properties": {
"effective_date": {
"oneOf": [
{
"type": "string",
"format": "date"
},
{
"type": "null"
}
],
"title": "Effective Date",
"description": "The date on which the phase change should take effect. If not provided, defaults to today in the customer's timezone."
},
"allow_invoice_credit_or_void": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Allow Invoice Credit Or Void",
"description": "If false, this request will fail if it would void an issued invoice or create a credit note. Consider using this as a safety mechanism if you do not expect existing invoices to be changed.",
"default": true
}
},
"additionalProperties": false,
"type": "object",
"title": "TriggerSubscriptionPhaseParams"
},
"URLNotFound": {
"properties": {
"type": {
"type": "string",
"enum": [
"https://docs.withorb.com/reference/error-responses#404-url-not-found"
],
"title": "Type"
},
"status": {
"type": "integer",
"enum": [
404
],
"title": "Status"
},
"detail": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Detail"
},
"title": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Title"
}
},
"type": "object",
"required": [
"type",
"status"
],
"title": "URLNotFound"
},
"UngroupedSubscriptionUsage": {
"properties": {
"data": {
"items": {
"$ref": "#/components/schemas/UngroupedSubscriptionUsageRecord"
},
"type": "array",
"title": "Data"
}
},
"type": "object",
"required": [
"data"
],
"title": "UngroupedSubscriptionUsage"
},
"UngroupedSubscriptionUsageRecord": {
"properties": {
"usage": {
"items": {
"$ref": "#/components/schemas/Usage"
},
"type": "array",
"title": "Usage"
},
"billable_metric": {
"$ref": "#/components/schemas/BillableMetricSimple"
},
"view_mode": {
"type": "string",
"enum": [
"periodic",
"cumulative"
],
"title": "View Mode"
}
},
"type": "object",
"required": [
"usage",
"billable_metric",
"view_mode"
],
"title": "UngroupedSubscriptionUsageRecord"
},
"UnitConfig": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Rate per unit of usage"
},
"prorated": {
"type": "boolean",
"title": "Prorated",
"description": "If true, subtotals from this price are prorated based on the service period",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "UnitConfig",
"description": "Configuration for unit pricing"
},
"UnitConversionRateConfig": {
"properties": {
"conversion_rate_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Conversion Rate Type"
},
"unit_config": {
"$ref": "#/components/schemas/ConversionRateUnitConfig"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"conversion_rate_type",
"unit_config"
],
"title": "UnitConversionRateConfig"
},
"UnitPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_config": {
"$ref": "#/components/schemas/UnitConfig"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"unit_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "UnitPrice"
},
"UnitWithPercentConfig": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Rate per unit of usage"
},
"percent": {
"type": "string",
"title": "Percent",
"description": "What percent, out of 100, of the calculated total to charge"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount",
"percent"
],
"title": "UnitWithPercentConfig",
"description": "Configuration for unit pricing with percentage"
},
"UnitWithPercentPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_percent"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_percent_config": {
"$ref": "#/components/schemas/UnitWithPercentConfig",
"description": "Configuration for unit_with_percent pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"unit_with_percent_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "UnitWithPercentPrice"
},
"UnitWithProrationConfig": {
"properties": {
"unit_amount": {
"type": "string",
"title": "Unit Amount",
"description": "Rate per unit of usage"
}
},
"additionalProperties": false,
"type": "object",
"required": [
"unit_amount"
],
"title": "UnitWithProrationConfig",
"description": "Configuration for unit pricing with proration"
},
"UnitWithProrationPrice": {
"properties": {
"model_type": {
"type": "string",
"enum": [
"unit_with_proration"
],
"title": "Model Type",
"description": "The pricing model type"
},
"unit_with_proration_config": {
"$ref": "#/components/schemas/UnitWithProrationConfig",
"description": "Configuration for unit_with_proration pricing"
},
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"name": {
"type": "string",
"title": "Name"
},
"external_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "External Price Id"
},
"replaces_price_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Replaces Price Id",
"description": "The price id this price replaces. This price will take the place of the replaced price in plan version migrations."
},
"price_type": {
"type": "string",
"enum": [
"usage_price",
"fixed_price",
"composite_price"
],
"title": "Price Type"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"cadence": {
"type": "string",
"enum": [
"one_time",
"monthly",
"quarterly",
"semi_annual",
"annual",
"custom"
],
"title": "Cadence"
},
"billing_mode": {
"type": "string",
"enum": [
"in_advance",
"in_arrear"
],
"title": "Billing Mode"
},
"billing_cycle_configuration": {
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
"invoicing_cycle_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/BillingCycleConfiguration"
},
{
"type": "null"
}
]
},
"billable_metric": {
"oneOf": [
{
"$ref": "#/components/schemas/BillableMetricTiny"
},
{
"type": "null"
}
]
},
"dimensional_price_configuration": {
"oneOf": [
{
"$ref": "#/components/schemas/DimensionalPriceConfiguration"
},
{
"type": "null"
}
]
},
"fixed_price_quantity": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Fixed Price Quantity"
},
"plan_phase_order": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Plan Phase Order"
},
"currency": {
"type": "string",
"title": "Currency"
},
"conversion_rate": {
"oneOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Conversion Rate"
},
"conversion_rate_config": {
"oneOf": [
{
"$ref": "#/components/schemas/ConversionRateConfig"
},
{
"type": "null"
}
]
},
"item": {
"$ref": "#/components/schemas/ItemSlim"
},
"credit_allocation": {
"oneOf": [
{
"$ref": "#/components/schemas/Allocation"
},
{
"type": "null"
}
]
},
"composite_price_filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Composite Price Filters"
},
"invoice_grouping_key": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Grouping Key"
},
"license_type": {
"oneOf": [
{
"$ref": "#/components/schemas/LicenseType"
},
{
"type": "null"
}
]
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/Discount"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
],
"deprecated": true
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount",
"deprecated": true
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
],
"deprecated": true
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount",
"deprecated": true
}
},
"type": "object",
"required": [
"model_type",
"unit_with_proration_config",
"metadata",
"id",
"name",
"external_price_id",
"replaces_price_id",
"price_type",
"created_at",
"cadence",
"billing_mode",
"billing_cycle_configuration",
"invoicing_cycle_configuration",
"billable_metric",
"fixed_price_quantity",
"plan_phase_order",
"currency",
"conversion_rate",
"conversion_rate_config",
"item",
"credit_allocation",
"composite_price_filters",
"invoice_grouping_key",
"discount",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount"
],
"title": "UnitWithProrationPrice"
},
"UnscheduleFixedFeeQuantityChangeParams": {
"properties": {
"price_id": {
"type": "string",
"title": "Price Id",
"description": "Price for which the updates should be cleared. Must be a fixed fee."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"price_id"
],
"title": "UnscheduleFixedFeeQuantityChangeParams"
},
"UpcomingInvoice": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"voided_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Voided At",
"description": "If the invoice has a status of `void`, this gives a timestamp when the invoice was voided."
},
"paid_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Paid At",
"description": "If the invoice has a status of `paid`, this gives a timestamp when the invoice was paid."
},
"issued_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issued At",
"description": "If the invoice has been issued, this will be the time it transitioned to `issued` (even if it is now in a different state.)"
},
"scheduled_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Scheduled Issue At",
"description": "If the invoice is in draft, this timestamp will reflect when the invoice is scheduled to be issued."
},
"auto_collection": {
"$ref": "#/components/schemas/AutoCollection"
},
"issue_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Issue Failed At",
"description": "If the invoice failed to issue, this will be the last time it failed to issue (even if it is now in a different state.)"
},
"sync_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Sync Failed At",
"description": "If the invoice failed to sync, this will be the last time an external invoicing provider sync was attempted. This field will always be `null` for invoices using Orb Invoicing."
},
"payment_failed_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Failed At",
"description": "If payment was attempted on this invoice but failed, this will be the time of the most recent attempt."
},
"payment_started_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Payment Started At",
"description": "If payment was attempted on this invoice, this will be the start time of the most recent attempt. This field is especially useful for delayed-notification payment mechanisms (like bank transfers), where payment can take 3 days or more."
},
"amount_due": {
"type": "string",
"title": "Amount Due",
"description": "This is the final amount required to be charged to the customer and reflects the application of the customer balance to the `total` of the invoice.",
"examples": [
"8.00"
]
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At",
"description": "The creation time of the resource in Orb.",
"examples": [
"2022-05-01T07:01:31+00:00"
]
},
"currency": {
"type": "string",
"title": "Currency",
"description": "An ISO 4217 currency string or `credits`",
"examples": [
"USD"
]
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "When the invoice payment is due. The due date is null if the invoice is not yet finalized.",
"examples": [
"2022-05-30T07:00:00+00:00"
]
},
"id": {
"type": "string",
"title": "Id"
},
"invoice_pdf": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoice Pdf",
"description": "The link to download the PDF representation of the `Invoice`.",
"examples": [
"https://assets.withorb.com/invoice/rUHdhmg45vY45DX/qEAeuYePaphGMdFb"
]
},
"invoice_number": {
"type": "string",
"title": "Invoice Number",
"description": "Automatically generated invoice number to help track and reconcile invoices. Invoice numbers have a prefix such as `RFOBWG`. These can be sequential per account or customer.",
"examples": [
"JYEFHK-00001"
]
},
"subscription": {
"oneOf": [
{
"$ref": "#/components/schemas/SubscriptionMinified"
},
{
"type": "null"
}
]
},
"total": {
"type": "string",
"title": "Total",
"description": "The total after any minimums and discounts have been applied.",
"examples": [
"8.00"
]
},
"customer_balance_transactions": {
"items": {
"$ref": "#/components/schemas/CustomerBalanceTransaction"
},
"type": "array",
"title": "Customer Balance Transactions"
},
"status": {
"type": "string",
"enum": [
"issued",
"paid",
"synced",
"void",
"draft"
],
"title": "Status"
},
"invoice_source": {
"type": "string",
"enum": [
"subscription",
"partial",
"one_off"
],
"title": "Invoice Source"
},
"shipping_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"billing_address": {
"oneOf": [
{
"$ref": "#/components/schemas/Address"
},
{
"type": "null"
}
]
},
"hosted_invoice_url": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Hosted Invoice Url",
"description": "A URL for the customer-facing invoice portal. This URL expires 60 days after the link is generated, or 30 days after the invoice's due date \u2014 whichever is later."
},
"will_auto_issue": {
"type": "boolean",
"title": "Will Auto Issue",
"description": "This is true if the invoice will be automatically issued in the future, and false otherwise."
},
"eligible_to_issue_at": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "Eligible To Issue At",
"description": "If the invoice has a status of `draft`, this will be the time that the invoice will be eligible to be issued, otherwise it will be `null`. If `auto-issue` is true, the invoice will automatically begin issuing at this time."
},
"customer_tax_id": {
"oneOf": [
{
"$ref": "#/components/schemas/CustomerTaxId"
},
{
"type": "null"
}
]
},
"memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Memo",
"description": "Free-form text which is available on the invoice PDF and the Orb invoice portal."
},
"credit_notes": {
"items": {
"$ref": "#/components/schemas/CreditNoteSummary"
},
"type": "array",
"title": "Credit Notes",
"description": "A list of credit notes associated with the invoice"
},
"payment_attempts": {
"items": {
"$ref": "#/components/schemas/PaymentAttempt"
},
"type": "array",
"title": "Payment Attempts",
"description": "A list of payment attempts associated with the invoice"
},
"discount": {
"oneOf": [
{
"$ref": "#/components/schemas/DEPRECATED_InvoiceLevelDiscount"
},
{
"type": "null"
}
],
"description": "This field is deprecated in favor of `discounts`. If a `discounts` list is provided, the first discount in the list will be returned. If the list is empty, `None` will be returned.",
"deprecated": true
},
"discounts": {
"items": {
"$ref": "#/components/schemas/InvoiceLevelDiscount"
},
"type": "array",
"title": "Discounts"
},
"minimum": {
"oneOf": [
{
"$ref": "#/components/schemas/Minimum"
},
{
"type": "null"
}
]
},
"minimum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Minimum Amount"
},
"maximum": {
"oneOf": [
{
"$ref": "#/components/schemas/Maximum"
},
{
"type": "null"
}
]
},
"maximum_amount": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Maximum Amount"
},
"line_items": {
"items": {
"$ref": "#/components/schemas/InvoiceLineItem"
},
"type": "array",
"title": "Line Items",
"description": "The breakdown of prices in this invoice."
},
"subtotal": {
"type": "string",
"title": "Subtotal",
"description": "The total before any discounts and minimums are applied.",
"examples": [
"8.00"
]
},
"target_date": {
"type": "string",
"format": "date-time",
"title": "Target Date",
"description": "The scheduled date of the invoice",
"examples": [
"2022-05-01T07:00:00+00:00"
]
}
},
"type": "object",
"required": [
"metadata",
"voided_at",
"paid_at",
"issued_at",
"scheduled_issue_at",
"auto_collection",
"issue_failed_at",
"sync_failed_at",
"payment_failed_at",
"payment_started_at",
"amount_due",
"created_at",
"currency",
"customer",
"due_date",
"id",
"invoice_pdf",
"invoice_number",
"subscription",
"total",
"customer_balance_transactions",
"status",
"invoice_source",
"shipping_address",
"billing_address",
"hosted_invoice_url",
"will_auto_issue",
"eligible_to_issue_at",
"customer_tax_id",
"memo",
"credit_notes",
"payment_attempts",
"discount",
"discounts",
"minimum",
"minimum_amount",
"maximum",
"maximum_amount",
"line_items",
"subtotal",
"target_date"
],
"title": "UpcomingInvoice"
},
"UpdateAlertQueryParams": {
"properties": {
"subscription_id": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subscription Id",
"description": "Used to update the status of a plan alert scoped to this subscription_id"
}
},
"additionalProperties": false,
"type": "object",
"title": "UpdateAlertQueryParams"
},
"UpdateAlertRequestParams": {
"properties": {
"thresholds": {
"items": {
"$ref": "#/components/schemas/Threshold"
},
"type": "array",
"title": "Thresholds",
"description": "The thresholds that define the values at which the alert will be triggered."
}
},
"additionalProperties": false,
"type": "object",
"required": [
"thresholds"
],
"title": "UpdateAlertRequestParams"
},
"UpdateInvoiceRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"net_terms": {
"oneOf": [
{
"type": "integer",
"minimum": 0.0
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "The net terms determines the due date of the invoice. Due date is calculated based on the invoice or issuance date, depending on the account's configured due date calculation method. A value of '0' here represents that the invoice is due on issue, whereas a value of '30' represents that the customer has 30 days to pay the invoice. Do not set this field if you want to set a custom due date.",
"examples": [
0
]
},
"due_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Due Date",
"description": "An optional custom due date for the invoice. If not set, the due date will be calculated based on the `net_terms` value.",
"examples": [
"2023-09-22"
]
},
"invoice_date": {
"oneOf": [
{
"type": "string",
"format": "date",
"title": "date"
},
{
"type": "string",
"format": "date-time",
"title": "date-time"
},
{
"type": "null"
}
],
"title": "Invoice Date",
"description": "The date of the invoice. Can only be modified for one-off draft invoices.",
"examples": [
"2023-09-22"
]
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether this invoice will automatically attempt to charge a saved payment method, if any. Can only be modified on draft invoices. If not specified, the invoice's existing setting is unchanged."
}
},
"additionalProperties": false,
"type": "object",
"title": "UpdateInvoiceRequestParams"
},
"UpdateMetricRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
}
},
"additionalProperties": false,
"type": "object",
"title": "UpdateMetricRequestParams"
},
"UpdatePriceRequestParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
}
},
"additionalProperties": false,
"type": "object",
"title": "UpdatePriceRequestParams"
},
"UpdateSubscriptionParams": {
"properties": {
"metadata": {
"oneOf": [
{
"additionalProperties": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
]
},
"type": "object"
},
{
"type": "null"
}
],
"title": "Metadata",
"description": "User-specified key/value pairs for the resource. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"default_invoice_memo": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Default Invoice Memo",
"description": "Determines the default memo on this subscription's invoices. Note that if this is not provided, it is determined by the plan configuration."
},
"auto_collection": {
"oneOf": [
{
"type": "boolean"
},
{
"type": "null"
}
],
"title": "Auto Collection",
"description": "Determines whether issued invoices for this subscription will automatically be charged with the saved payment method on the due date. This property defaults to the plan's behavior."
},
"net_terms": {
"oneOf": [
{
"type": "integer"
},
{
"type": "null"
}
],
"title": "Net Terms",
"description": "Determines the difference between the invoice issue date for subscription invoices as the date that they are due. A value of `0` here represents that the invoice is due on issue, whereas a value of `30` represents that the customer has a month to pay the invoice."
},
"invoicing_threshold": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Invoicing Threshold",
"description": "When this subscription's accrued usage reaches this threshold, an invoice will be issued for the subscription. If not specified, invoices will only be issued at the end of the billing period.",
"examples": [
"10.00"
]
}
},
"additionalProperties": false,
"type": "object",
"title": "UpdateSubscriptionParams"
},
"UpdateTrialRequestParams": {
"properties": {
"trial_end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"enum": [
"immediate"
]
}
],
"title": "Trial End Date",
"description": "The new date that the trial should end, or the literal string `immediate` to end the trial immediately. ",
"examples": [
"2017-07-21T17:32:28Z"
]
},
"shift": {
"type": "boolean",
"title": "Shift",
"description": "If true, shifts subsequent price and adjustment intervals (preserving their durations, but adjusting their absolute dates).",
"default": false
}
},
"additionalProperties": false,
"type": "object",
"required": [
"trial_end_date"
],
"title": "UpdateTrialRequestParams"
},
"Usage": {
"properties": {
"quantity": {
"type": "number",
"title": "Quantity"
},
"timeframe_start": {
"type": "string",
"format": "date-time",
"title": "Timeframe Start"
},
"timeframe_end": {
"type": "string",
"format": "date-time",
"title": "Timeframe End"
}
},
"type": "object",
"required": [
"quantity",
"timeframe_start",
"timeframe_end"
],
"title": "Usage"
},
"UsageDiscount": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"usage"
],
"title": "Discount Type"
},
"applies_to_price_ids": {
"oneOf": [
{
"items": {
"type": "string"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Applies To Price Ids",
"description": "List of price_ids that this discount applies to. For plan/plan phase discounts, this can be a subset of prices.",
"examples": [
[
"h74gfhdjvn7ujokd",
"7hfgtgjnbvc3ujkl"
]
]
},
"filters": {
"oneOf": [
{
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array"
},
{
"type": "null"
}
],
"title": "Filters",
"description": "The filters that determine which prices to apply this discount to."
},
"reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Reason"
},
"usage_discount": {
"type": "number",
"title": "Usage Discount",
"description": "Only available if discount_type is `usage`. Number of usage units that this discount is for"
}
},
"type": "object",
"required": [
"discount_type",
"usage_discount"
],
"title": "UsageDiscount"
},
"UsageDiscountCreationParams": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"usage"
],
"title": "Discount Type"
},
"usage_discount": {
"type": "number",
"minimum": 0.0,
"title": "Usage Discount",
"description": "Only available if discount_type is `usage`. Number of usage units that this discount is for.",
"examples": [
2
]
}
},
"type": "object",
"required": [
"discount_type",
"usage_discount"
],
"title": "UsageDiscountCreationParams"
},
"UsageDiscountInterval": {
"properties": {
"discount_type": {
"type": "string",
"enum": [
"usage"
],
"title": "Discount Type"
},
"usage_discount": {
"type": "number",
"title": "Usage Discount",
"description": "Only available if discount_type is `usage`. Number of usage units that this discount is for"
},
"start_date": {
"type": "string",
"format": "date-time",
"title": "Start Date",
"description": "The start date of the discount interval."
},
"end_date": {
"oneOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "null"
}
],
"title": "End Date",
"description": "The end date of the discount interval."
},
"filters": {
"items": {
"$ref": "#/components/schemas/PriceFilter"
},
"type": "array",
"title": "Filters",
"description": "The filters that determine which prices this discount interval applies to."
},
"applies_to_price_interval_ids": {
"items": {
"type": "string"
},
"type": "array",
"title": "Applies To Price Interval Ids",
"description": "The price interval ids that this discount interval applies to."
}
},
"type": "object",
"required": [
"discount_type",
"usage_discount",
"start_date",
"end_date",
"filters",
"applies_to_price_interval_ids"
],
"title": "UsageDiscountInterval"
},
"ValidationError": {
"properties": {
"idempotency_key": {
"type": "string",
"title": "Idempotency Key",
"description": "The passed idempotency_key corresponding to the validation_errors"
},
"validation_errors": {
"items": {
"type": "string"
},
"type": "array",
"title": "Validation Errors",
"description": "An array of strings corresponding to validation failures for this idempotency_key."
}
},
"type": "object",
"required": [
"idempotency_key",
"validation_errors"
],
"title": "ValidationError"
},
"VoidInitiatedLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"void_initiated"
],
"title": "Entry Type"
},
"new_block_expiry_date": {
"type": "string",
"format": "date-time",
"title": "New Block Expiry Date"
},
"void_reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Void Reason"
},
"void_amount": {
"type": "number",
"title": "Void Amount"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type",
"new_block_expiry_date",
"void_reason",
"void_amount"
],
"title": "VoidInitiatedLedgerEntry"
},
"VoidLedgerEntry": {
"properties": {
"metadata": {
"additionalProperties": {
"type": "string"
},
"type": "object",
"title": "Metadata",
"description": "User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to `null`, and the entire metadata mapping can be cleared by setting `metadata` to `null`."
},
"id": {
"type": "string",
"title": "Id"
},
"ledger_sequence_number": {
"type": "integer",
"title": "Ledger Sequence Number"
},
"entry_status": {
"type": "string",
"enum": [
"committed",
"pending"
],
"title": "Entry Status"
},
"customer": {
"$ref": "#/components/schemas/CustomerMinified"
},
"starting_balance": {
"type": "number",
"title": "Starting Balance"
},
"ending_balance": {
"type": "number",
"title": "Ending Balance"
},
"amount": {
"type": "number",
"title": "Amount"
},
"currency": {
"type": "string",
"title": "Currency"
},
"created_at": {
"type": "string",
"format": "date-time",
"title": "Created At"
},
"description": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description"
},
"credit_block": {
"$ref": "#/components/schemas/AffectedBlock"
},
"entry_type": {
"type": "string",
"enum": [
"void"
],
"title": "Entry Type"
},
"void_reason": {
"oneOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Void Reason"
},
"void_amount": {
"type": "number",
"title": "Void Amount"
}
},
"type": "object",
"required": [
"metadata",
"id",
"ledger_sequence_number",
"entry_status",
"customer",
"starting_balance",
"ending_balance",
"amount",
"currency",
"created_at",
"description",
"credit_block",
"entry_type",
"void_reason",
"void_amount"
],
"title": "VoidLedgerEntry"
}
},
"securitySchemes": {
"APIKeyAuth": {
"type": "http",
"description": "API Keys can be issued in the Orb's web application.",
"scheme": "bearer"
}
}
},
"security": [
{
"APIKeyAuth": []
}
],
"tags": [
{
"name": "Alert",
"description": "[Alerts within Orb](/product-catalog/configuring-alerts) monitor spending,\nusage, or credit balance and trigger webhooks when a threshold is exceeded.\n\nAlerts created through the API can be scoped to either customers or subscriptions."
},
{
"name": "Availability"
},
{
"name": "Coupon",
"description": "A coupon represents a reusable discount configuration that can be applied either as a fixed or percentage amount to an invoice or subscription. Coupons are activated using a redemption code, which applies the discount to a subscription or invoice. The duration of a coupon determines how long it remains available for use by end users."
},
{
"name": "Credit",
"description": "The [Credit Ledger Entry resource](/product-catalog/prepurchase) models prepaid credits within Orb."
},
{
"name": "Credit note",
"description": "The [Credit Note](/invoicing/credit-notes) resource represents a credit that has been applied to a\nparticular invoice."
},
{
"name": "Customer",
"description": "A customer is a buyer of your products, and the other party to the billing relationship.\n\nIn Orb, customers are assigned system generated identifiers automatically, but it's often desirable to have these\nmatch existing identifiers in your system. To avoid having to denormalize Orb ID information, you can pass in an\n`external_customer_id` with your own identifier. See\n[Customer ID Aliases](/events-and-metrics/customer-aliases) for further information about how these\naliases work in Orb.\n\nIn addition to having an identifier in your system, a customer may exist in a payment provider solution like\nStripe. Use the `payment_provider_id` and the `payment_provider` enum field to express this mapping.\n\nA customer also has a timezone (from the standard [IANA timezone database](https://www.iana.org/time-zones)), which\ndefaults to your account's timezone. See [Timezone localization](/essentials/timezones) for\ninformation on what this timezone parameter influences within Orb."
},
{
"name": "Dimensional Price Group"
},
{
"name": "Event",
"description": "The [Event](/core-concepts#event) resource represents a usage event that has been created for a\ncustomer. Events are the core of Orb's usage-based billing model, and are used to calculate the usage charges for\na given billing period."
},
{
"name": "Invoice",
"description": "An [`Invoice`](/core-concepts#invoice) is a fundamental billing entity, representing the request for payment for\na single subscription. This includes a set of line items, which correspond to prices in the subscription's plan and\ncan represent fixed recurring fees or usage-based fees. They are generated at the end of a billing period, or as\nthe result of an action, such as a cancellation."
},
{
"name": "Item",
"description": "The Item resource represents a sellable product or good. Items are associated with all line items, billable metrics,\nand prices and are used for defining external sync behavior for invoices and tax calculation purposes."
},
{
"name": "License"
},
{
"name": "LicenseType",
"description": "The LicenseType resource represents a type of license that can be assigned to users.\nLicense types are used during billing by grouping metrics on the configured grouping key."
},
{
"name": "Metric",
"description": "The Metric resource represents a calculation of a quantity based on events.\nMetrics are defined by the query that transforms raw usage events into meaningful values for your customers."
},
{
"name": "Plan",
"description": "The [Plan](/core-concepts#plan-and-price) resource represents a plan that can be subscribed to by a\ncustomer. Plans define the billing behavior of the subscription. You can see more about how to configure prices\nin the [Price resource](/reference/price)."
},
{
"name": "Price",
"description": "The Price resource represents a price that can be billed on a subscription, resulting in a charge on an invoice in\nthe form of an invoice line item. Prices take a quantity and determine an amount to bill.\n\nOrb supports a few different pricing models out of the box. Each of these models is serialized differently in a\ngiven Price object. The model_type field determines the key for the configuration object that is present.\n\nFor more on the types of prices, see [the core concepts documentation](/core-concepts#plan-and-price)"
},
{
"name": "Price interval",
"description": "The Price Interval resource represents a period of time for which a price will bill on a subscription. A\nsubscription\u2019s price intervals define its billing behavior."
},
{
"name": "Subscription",
"description": "A [subscription](/core-concepts#subscription) represents the purchase of a plan by a customer.\n\nBy default, subscriptions begin on the day that they're created and renew automatically for each billing cycle at\nthe cadence that's configured in the plan definition.\n\nSubscriptions also default to **beginning of month alignment**, which means the first invoice issued for the\nsubscription will have pro-rated charges between the `start_date` and the first of the following month. Subsequent\nbilling periods will always start and end on a month boundary (e.g. subsequent month starts for monthly billing).\n\nDepending on the plan configuration, any _flat_ recurring fees will be billed either at the beginning (in-advance)\nor end (in-arrears) of each billing cycle. Plans default to **in-advance billing**. Usage-based fees are billed in\narrears as usage is accumulated. In the normal course of events, you can expect an invoice to contain usage-based\ncharges for the previous period, and a recurring fee for the following period."
},
{
"name": "Subscription Change"
}
]
}