openapi: 3.0.3 info: title: Lotus API version: 0.9.3 description: Lotus is an open-core pricing and billing engine. We enable API companies to automate and optimize their custom usage-based pricing for any metric. paths: /api/credits/: get: operationId: api_credits_list parameters: - in: query name: currency_code schema: type: string minLength: 1 description: Filter to adjustments in a specific currency - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: true - in: query name: effective_after schema: type: string format: date-time description: Filter to adjustments that are effective after this date - in: query name: effective_before schema: type: string format: date-time description: Filter to adjustments that are effective before this date - in: query name: expires_after schema: type: string format: date-time description: Filter to adjustments that expire after this date - in: query name: expires_before schema: type: string format: date-time description: Filter to adjustments that expire before this date - in: query name: issued_after schema: type: string format: date-time description: Filter to adjustments that were issued after this date - in: query name: issued_before schema: type: string format: date-time description: Filter to adjustments that were issued before this date - in: query name: status schema: type: array items: enum: - active - inactive type: string description: |- * `active` - Active * `inactive` - Inactive default: - active - inactive description: Filter to a specific set of adjustment statuses. Defaults to both active and inactive. tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/CustomerBalanceAdjustment' description: '' post: operationId: api_credits_create tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentCreateRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustment' description: '' /api/credits/{credit_id}/: get: operationId: api_credits_retrieve parameters: - in: path name: credit_id schema: type: string description: The ID of the credit to retrieve or update. required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustment' description: '' /api/credits/{credit_id}/update/: post: operationId: api_credits_update_create parameters: - in: path name: credit_id schema: type: string description: The ID of the credit to retrieve or update. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CustomerBalanceAdjustmentUpdateRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustment' description: '' /api/credits/{credit_id}/void/: post: operationId: api_credits_void_create parameters: - in: path name: credit_id schema: type: string description: The ID of the credit to retrieve or update. required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerBalanceAdjustment' description: '' /api/customer_feature_access/: get: operationId: api_customer_feature_access_list parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: The customer_id of the customer you want to check access. required: true - in: query name: feature_name schema: type: string minLength: 1 description: Name of the feature to check access for. required: true - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: The subscription filters that are applied to this plan's relationship with the customer. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you. This must be passed in as a stringified JSON object. tags: - api security: - OrganizationApiKeyAuth: [] TokenAuth: [] deprecated: true responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/GetFeatureAccess' description: '' /api/customer_metric_access/: get: operationId: api_customer_metric_access_list parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: The customer_id of the customer you want to check access. required: true - in: query name: event_name schema: type: string nullable: true minLength: 1 description: The name of the event you are checking access for. - in: query name: metric_id schema: type: string format: uuid nullable: true description: The metric_id of the metric you are checking access for. Please note that you must porovide exactly one of event_name and metric_id are mutually; a validation error will be thrown if both or none are provided. - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: The subscription filters that are applied to this plan's relationship with the customer. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you. This must be passed in as a stringified JSON object. tags: - api security: - OrganizationApiKeyAuth: [] TokenAuth: [] deprecated: true responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/GetEventAccess' description: '' /api/customers/: get: operationId: api_customers_list tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Customer' description: '' post: operationId: api_customers_create tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/CustomerCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/CustomerCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/CustomerCreateRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' /api/customers/{customer_id}/: get: operationId: api_customers_retrieve parameters: - in: path name: customer_id schema: type: string description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Customer' description: '' /api/customers/{customer_id}/cost_analysis/: get: operationId: api_customers_cost_analysis_retrieve parameters: - in: path name: customer_id schema: type: string description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: true - in: query name: end_date schema: type: string format: date required: true - in: query name: start_date schema: type: string format: date required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CostAnalysis' description: '' /api/customers/{customer_id}/delete/: post: operationId: api_customers_delete_create parameters: - in: path name: customer_id schema: type: string description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/CustomerDeleteResponse' description: '' /api/customers/{customer_id}/draft_invoice/: get: operationId: api_customers_draft_invoice_retrieve parameters: - in: path name: customer_id schema: type: string description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: true - in: query name: include_next_period schema: type: boolean default: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': description: No response body /api/feature_access/: get: operationId: api_feature_access_retrieve parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: The customer_id of the customer you want to check access. required: true - in: query name: feature_id schema: type: string format: uuid description: The feature_id of the feature you want to check access for. required: true - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: "The subscription filters that are applied to this plan's relationship\ \ with the customer. If your billing model does not have the ability multiple\ \ plans or subscriptions per customer, this is likely not relevant for you. " tags: - api security: - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/FeatureAccessResponse' description: '' /api/healthcheck/: get: operationId: api_healthcheck_retrieve tags: - api security: - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': description: No response body /api/invoices/: get: operationId: api_invoices_list parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: A filter for invoices for a specific customer - in: query name: payment_status schema: type: array items: enum: - unpaid - paid type: string description: |- * `unpaid` - unpaid * `paid` - paid default: - paid description: A filter for invoices with a specific payment status tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Invoice' description: '' /api/invoices/{invoice_id}/: get: operationId: api_invoices_retrieve parameters: - in: path name: invoice_id schema: type: string format: uuid required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: '' patch: operationId: api_invoices_partial_update parameters: - in: path name: invoice_id schema: type: string format: uuid required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInvoiceUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/PatchedInvoiceUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/PatchedInvoiceUpdateRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/InvoicePayment' description: '' /api/invoices/{invoice_id}/pdf_url/: get: operationId: api_invoices_pdf_url_retrieve parameters: - in: path name: invoice_id schema: type: string description: Either an invoice ID (in the format `invoice_`) or an invoice number (in the format `YYMMDD-000001`) required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Invoice' description: '' /api/metric_access/: get: operationId: api_metric_access_retrieve parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: The customer_id of the customer you want to check access. required: true - in: query name: metric_id schema: type: string format: uuid description: The metric_id of the metric you want to check access for. required: true - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: 'Used if you want to restrict the access check to only plans that fulfill certain subscription filter criteria. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you. ' tags: - api security: - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/MetricAccessResponse' description: '' /api/ping/: get: operationId: api_ping_retrieve description: Ping the API to check if the API key is valid. tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConfirmConnected' examples: ConfirmConnected: value: organization_id: org_088c5d194bef40ed9aaeb72d42bd7945 summary: Example response for ConfirmConnected description: '' /api/plans/: get: operationId: api_plans_list parameters: - in: query name: duration schema: enum: - monthly - quarterly - yearly type: string minLength: 1 description: |- Filter to plans that have this duration. * `monthly` - Monthly * `quarterly` - Quarterly * `yearly` - Yearly - in: query name: exclude_tags schema: type: array items: type: string minLength: 1 description: Filter to plans that do not have any of the tags in this list. - in: query name: include_tags schema: type: array items: type: string minLength: 1 description: Filter to plans that have any of the tags in this list. - in: query name: include_tags_all schema: type: array items: type: string minLength: 1 description: Filter to plans that have all of the tags in this list. - in: query name: version_currency_code schema: type: string minLength: 1 description: Filter to versions that have the currency specified by this currency code. - in: query name: version_custom_type schema: enum: - custom_only - public_only - all type: string default: all minLength: 1 description: |- Filter to versions that have this custom type. If you choose custom_only, you will only see versions that have target customers. If you choose public_only, you will only see versions that do not have target customers. * `custom_only` - Custom Only * `public_only` - Public Only * `all` - All - in: query name: version_status schema: type: array items: enum: - active - ended - not_started type: string description: |- * `active` - Active * `ended` - Ended * `not_started` - Not Started default: - active - not_started - ended description: Filter to versions that have this status. Ended means it has an active_to date in the past. Not started means it has an active_from date in the future or null. tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/Plan' description: '' /api/plans/{plan_id}/: get: operationId: api_plans_retrieve parameters: - in: path name: plan_id schema: type: string format: uuid required: true - in: query name: version_currency_code schema: type: string minLength: 1 description: Filter to versions that have the currency specified by this currency code. - in: query name: version_custom_type schema: enum: - custom_only - public_only - all type: string default: all minLength: 1 description: |- Filter to versions that have this custom type. If you choose custom_only, you will only see versions that have target customers. If you choose public_only, you will only see versions that do not have target customers. * `custom_only` - Custom Only * `public_only` - Public Only * `all` - All - in: query name: version_status schema: type: array items: enum: - active - ended - not_started type: string description: |- * `active` - Active * `ended` - Ended * `not_started` - Not Started default: - active - not_started - ended description: Filter to versions that have this status. Ended means it has an active_to date in the past. Not started means it has an active_from date in the future or null. tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/Plan' description: '' /api/subscriptions/: get: operationId: api_subscriptions_list parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: Filter to a specific customer. required: true - in: query name: plan_id schema: type: string format: uuid description: Filter to a specific plan. - in: query name: range_end schema: type: string format: date-time description: If specified, will only return subscriptions with a start date before this date. - in: query name: range_start schema: type: string format: date-time description: If specified, will only return subscriptions with an end date after this date. - in: query name: status schema: type: array items: enum: - active - ended - not_started type: string description: |- * `active` - Active * `ended` - Ended * `not_started` - Not Started default: - active description: Filter to a specific set of subscription statuses. Defaults to active. - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'. tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriptionRecord' description: '' post: operationId: api_subscriptions_create tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordCreateRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '201': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/: get: operationId: api_subscriptions_retrieve parameters: - in: path name: subscription_id schema: type: string required: true tags: - api security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/addons/{addon_id}/cancel/: post: operationId: api_subscriptions_addons_cancel_create parameters: - in: path name: addon_id schema: type: string description: The ID of the addon within the subscription update. required: true - in: path name: subscription_id schema: type: string description: The ID of the subscription to update. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/AddOnSubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/addons/attach/: post: operationId: api_subscriptions_addons_attach_create parameters: - in: path name: subscription_id schema: type: string description: The ID of the subscription to add an addon to. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/AddOnSubscriptionRecordCreateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/AddOnSubscriptionRecordCreateRequest' multipart/form-data: schema: $ref: '#/components/schemas/AddOnSubscriptionRecordCreateRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddOnSubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/cancel/: post: operationId: api_subscriptions_cancel_create_2 parameters: - in: path name: subscription_id schema: type: string description: The ID of the subscription to cancel. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/components/{metric_id}/change_prepaid_units/: post: operationId: api_subscriptions_components_change_prepaid_units_create parameters: - in: path name: metric_id schema: type: string description: The ID of the metric to alter the prepaid usage for. required: true - in: path name: subscription_id schema: type: string description: The ID of the subscription which will have its plans switched. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangePrepaidUnitsRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ChangePrepaidUnitsRequest' multipart/form-data: schema: $ref: '#/components/schemas/ChangePrepaidUnitsRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/switch_plan/: post: operationId: api_subscriptions_switch_plan_create parameters: - in: path name: subscription_id schema: type: string description: The ID of the subscription which will have its plans switched. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordSwitchPlanRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordSwitchPlanRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordSwitchPlanRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/{subscription_id}/update/: post: operationId: api_subscriptions_update_create_2 parameters: - in: path name: subscription_id schema: type: string description: The ID of the subscription to update. required: true tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/add/: post: operationId: api_subscriptions_add_create tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordCreateSerializerOldRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordCreateSerializerOldRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordCreateSerializerOldRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] deprecated: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/cancel/: post: operationId: api_subscriptions_cancel_create parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: Filter to a specific customer. required: true - in: query name: plan_id schema: type: string format: uuid description: Filter to a specific plan. If not specified, all plans will be included in the cancellation request. - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordCancelRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] deprecated: true responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/subscriptions/update/: post: operationId: api_subscriptions_update_create parameters: - in: query name: customer_id schema: type: string nullable: true minLength: 1 description: Filter to a specific customer. required: true - in: query name: plan_id schema: type: string format: uuid description: Filter to a specific plan. required: true - in: query name: subscription_filters schema: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: Filter to a specific set of subscription filters. If your billing model only allows for one subscription per customer, you very likely do not need this field. Must be formatted as a JSON-encoded + stringified list of dictionaries, where each dictionary has a key of 'property_name' and a key of 'value'. tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateSerializerOldRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateSerializerOldRequest' multipart/form-data: schema: $ref: '#/components/schemas/SubscriptionRecordUpdateSerializerOldRequest' security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: type: array items: $ref: '#/components/schemas/SubscriptionRecord' description: '' /api/verify_idems_received/: post: operationId: api_verify_idems_received_create tags: - api requestBody: content: application/json: schema: $ref: '#/components/schemas/ConfirmIdemsReceivedRequestRequest' application/x-www-form-urlencoded: schema: $ref: '#/components/schemas/ConfirmIdemsReceivedRequestRequest' multipart/form-data: schema: $ref: '#/components/schemas/ConfirmIdemsReceivedRequestRequest' required: true security: - knoxTokenAuth: [] - OrganizationApiKeyAuth: [] TokenAuth: [] responses: '200': content: application/json: schema: $ref: '#/components/schemas/ConfirmIdemsReceived' description: '' '400': content: application/json: schema: $ref: '#/components/schemas/ConfirmIdemsReceivedFailure' description: '' components: schemas: APIToken: type: object properties: name: type: string description: A free-form name for the API key. Need not be unique. 50 characters max. maxLength: 50 prefix: type: string readOnly: true expiry_date: type: string format: date-time nullable: true title: Expires description: Once API key expires, clients cannot use it anymore. created: type: string format: date-time readOnly: true required: - created - prefix APITokenCreateResponse: type: object properties: api_key: $ref: '#/components/schemas/APIToken' key: type: string required: - api_key - key APITokenRequest: type: object properties: name: type: string minLength: 1 description: A free-form name for the API key. Need not be unique. 50 characters max. maxLength: 50 expiry_date: type: string format: date-time nullable: true title: Expires description: Once API key expires, clients cannot use it anymore. APITokenRollResponse: type: object properties: api_key: $ref: '#/components/schemas/APIToken' key: type: string required: - api_key - key AccessMethodsSubscriptionRecord: type: object properties: start_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' plan: $ref: '#/components/schemas/LightweightPlanVersion' required: - end_date - plan - start_date - subscription_filters Action: type: object description: DRF serializer for :class:`~activity.models.Action`. properties: id: type: integer readOnly: true actor: type: string readOnly: true verb: type: string maxLength: 255 action_object: type: string readOnly: true target: type: string readOnly: true public: type: boolean description: type: string nullable: true timestamp: type: string format: date-time required: - action_object - actor - id - target - verb AddFeatureRequest: type: object properties: feature_id: type: string format: uuid description: The feature_id of the feature you want to add to the plan. required: - feature_id AddFeatureResponse: type: object properties: success: type: boolean message: type: string required: - message - success AddFeatureToAddOnRequest: type: object properties: version_ids: type: array items: type: string format: uuid description: The version_ids of the AddOn versions you want to add the feature to. If you want to apply to all versions, use the all_versions parameter. feature_id: type: string format: uuid description: The feature_id of the feature you want to add to the plan. required: - feature_id AddFeatureToAddOnResponse: type: object properties: success: type: boolean message: type: string required: - message - success AddFeatureToPlanRequest: type: object properties: version_ids: type: array items: type: string format: uuid description: The version_ids of the plan versions you want to add the feature to. If you want to apply to all versions, use the all_versions parameter. all_versions: type: boolean default: false description: Whether or not to apply this feature to all versions of the feature. If you want to apply to specific versions, use the version_ids parameter. feature_id: type: string format: uuid description: The feature_id of the feature you want to add to the plan. required: - feature_id AddFeatureToPlanResponse: type: object properties: success: type: boolean message: type: string required: - message - success AddFeatureToPlanVersionNumberResponse: type: object properties: success: type: boolean message: type: string required: - message - success AddOnCreateRequest: type: object properties: addon_name: type: string minLength: 1 description: The name of the add-on plan. addon_description: type: string minLength: 1 description: The description of the add-on plan. initial_version: allOf: - $ref: '#/components/schemas/InitialAddOnVersionCreateRequest' description: The initial version of the add-on plan. required: - addon_description - addon_name - initial_version AddOnDetail: type: object properties: versions: type: array items: $ref: '#/components/schemas/AddOnVersion' description: This addon's versions. addon_name: type: string description: The name of the add-on plan. addon_description: type: string description: The description of the add-on plan. addon_id: type: string description: The ID of the add-on plan. required: - addon_description - addon_id - addon_name - versions AddOnSubscriptionRecord: type: object properties: addon_subscription_id: type: string customer: $ref: '#/components/schemas/LightweightCustomer' addon: $ref: '#/components/schemas/LightweightAddOn' start_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. parent: $ref: '#/components/schemas/LightweightSubscriptionRecord' fully_billed: type: boolean readOnly: true auto_renew: type: boolean readOnly: true description: Whether the subscription automatically renews. Defaults to true. metadata: type: object additionalProperties: {} readOnly: true required: - addon - addon_subscription_id - auto_renew - customer - end_date - fully_billed - metadata - parent - start_date AddOnSubscriptionRecordCreateRequest: type: object properties: addon_id: type: string format: uuid description: 'The add-on to be applied to the subscription. ' quantity: type: integer minimum: 1 default: 1 description: The quantity of the add-on to be applied to the subscription. Flat fees of add-ons will be multiplied by this quantity. Usage-based components of add-ons will be unaffected by the quantity. metadata: type: object additionalProperties: {} description: A JSON object containing additional information about the add-on subscription. This will be returned in the response when you retrieve the add-on subscription. AddOnUpdate: type: object properties: addon_name: type: string active_from: type: string format: date-time active_to: type: string format: date-time nullable: true AddOnVersion: type: object properties: recurring_charges: type: array items: $ref: '#/components/schemas/RecurringCharge' components: type: array items: $ref: '#/components/schemas/PlanComponent' features: type: array items: $ref: '#/components/schemas/Feature' status: enum: - active - retiring - grandfathered - deleted - inactive - not_started type: string description: |- * `active` - Active * `retiring` - Retiring * `grandfathered` - Grandfathered * `deleted` - Deleted * `inactive` - Inactive * `not_started` - Not Started readOnly: true currency: allOf: - $ref: '#/components/schemas/PricingUnit' description: Currency of the plan. Can only be null if the flat fee is 0 and all components are of type free. active_instances: type: integer readOnly: true description: The number of active instances of this version of the add-on plan. invoice_when: enum: - invoice_on_attach - invoice_on_subscription_end description: |- * `invoice_on_attach` - invoice_on_attach * `invoice_on_subscription_end` - invoice_on_subscription_end readOnly: true billing_frequency: enum: - one_time - recurring description: |- * `one_time` - one_time * `recurring` - recurring readOnly: true addon_type: enum: - usage_based - flat type: string readOnly: true required: - active_instances - addon_type - billing_frequency - components - currency - features - invoice_when - recurring_charges - status AddOnVersionCreateRequest: type: object properties: addon_id: type: string format: uuid recurring_charges: type: array items: $ref: '#/components/schemas/RecurringChargeCreateRequest' nullable: true components: type: array items: $ref: '#/components/schemas/PlanComponentCreateRequest' nullable: true features: type: array items: type: string format: uuid currency_code: type: string minLength: 1 invoice_when: enum: - invoice_on_attach - invoice_on_subscription_end description: |- * `invoice_on_attach` - invoice_on_attach * `invoice_on_subscription_end` - invoice_on_subscription_end billing_frequency: enum: - one_time - recurring description: |- * `one_time` - one_time * `recurring` - recurring required: - addon_id - billing_frequency - currency_code - invoice_when AddOnVersionDetail: type: object properties: recurring_charges: type: array items: $ref: '#/components/schemas/RecurringCharge' components: type: array items: $ref: '#/components/schemas/PlanComponent' features: type: array items: $ref: '#/components/schemas/Feature' status: enum: - active - retiring - grandfathered - deleted - inactive - not_started type: string description: |- * `active` - Active * `retiring` - Retiring * `grandfathered` - Grandfathered * `deleted` - Deleted * `inactive` - Inactive * `not_started` - Not Started readOnly: true currency: allOf: - $ref: '#/components/schemas/PricingUnit' description: Currency of the plan. Can only be null if the flat fee is 0 and all components are of type free. active_instances: type: integer readOnly: true description: The number of active instances of this version of the add-on plan. invoice_when: enum: - invoice_on_attach - invoice_on_subscription_end description: |- * `invoice_on_attach` - invoice_on_attach * `invoice_on_subscription_end` - invoice_on_subscription_end readOnly: true billing_frequency: enum: - one_time - recurring description: |- * `one_time` - one_time * `recurring` - recurring readOnly: true addon_type: enum: - usage_based - flat type: string readOnly: true required: - active_instances - addon_type - billing_frequency - components - currency - features - invoice_when - recurring_charges - status AddOnVersionUpdate: type: object properties: addon_version_name: type: string active_from: type: string format: date-time nullable: true active_to: type: string format: date-time nullable: true AddPlanTags: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' success: type: boolean message: type: string required: - message - success AddPlanTagsRequest: type: object properties: tags: type: array items: $ref: '#/components/schemas/TagRequest' AddTargetCustomerResponse: type: object properties: success: type: boolean message: type: string required: - message - success Address: type: object properties: city: type: string description: City, district, suburb, town, or village maxLength: 50 country: enum: - AW - AF - AO - AI - AX - AL - AD - AE - AR - AM - AS - AQ - TF - AG - AU - AT - AZ - BI - BE - BJ - BQ - BF - BD - BG - BH - BS - BA - BL - BY - BZ - BM - BO - BR - BB - BN - BT - BV - BW - CF - CA - CC - CH - CL - CN - CI - CM - CD - CG - CK - CO - KM - CV - CR - CU - CW - CX - KY - CY - CZ - DE - DJ - DM - DK - DO - DZ - EC - EG - ER - EH - ES - EE - ET - FI - FJ - FK - FR - FO - FM - GA - GB - GE - GG - GH - GI - GN - GP - GM - GW - GQ - GR - GD - GL - GT - GF - GU - GY - HK - HM - HN - HR - HT - HU - ID - IM - IN - IO - IE - IR - IQ - IS - IL - IT - JM - JE - JO - JP - KZ - KE - KG - KH - KI - KN - KR - KW - LA - LB - LR - LY - LC - LI - LK - LS - LT - LU - LV - MO - MF - MA - MC - MD - MG - MV - MX - MH - MK - ML - MT - MM - ME - MN - MP - MZ - MR - MS - MQ - MU - MW - MY - YT - NA - NC - NE - NF - NG - NI - NU - NL - NO - NP - NR - NZ - OM - PK - PA - PN - PE - PH - PW - PG - PL - PR - KP - PT - PY - PS - PF - QA - RE - RO - RU - RW - SA - SD - SN - SG - GS - SH - SJ - SB - SL - SV - SM - SO - PM - RS - SS - ST - SR - SK - SI - SE - SZ - SX - SC - SY - TC - TD - TG - TH - TJ - TK - TM - TL - TO - TT - TN - TR - TV - TW - TZ - UG - UA - UM - UY - US - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - ZA - ZM - ZW type: string description: |- Two-letter country code (ISO 3166-1 alpha-2) * `AW` - Aruba * `AF` - Afghanistan * `AO` - Angola * `AI` - Anguilla * `AX` - Åland Islands * `AL` - Albania * `AD` - Andorra * `AE` - United Arab Emirates * `AR` - Argentina * `AM` - Armenia * `AS` - American Samoa * `AQ` - Antarctica * `TF` - French Southern Territories * `AG` - Antigua and Barbuda * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BI` - Burundi * `BE` - Belgium * `BJ` - Benin * `BQ` - Bonaire, Sint Eustatius and Saba * `BF` - Burkina Faso * `BD` - Bangladesh * `BG` - Bulgaria * `BH` - Bahrain * `BS` - Bahamas * `BA` - Bosnia and Herzegovina * `BL` - Saint Barthélemy * `BY` - Belarus * `BZ` - Belize * `BM` - Bermuda * `BO` - Bolivia, Plurinational State of * `BR` - Brazil * `BB` - Barbados * `BN` - Brunei Darussalam * `BT` - Bhutan * `BV` - Bouvet Island * `BW` - Botswana * `CF` - Central African Republic * `CA` - Canada * `CC` - Cocos (Keeling) Islands * `CH` - Switzerland * `CL` - Chile * `CN` - China * `CI` - Côte d'Ivoire * `CM` - Cameroon * `CD` - Congo, The Democratic Republic of the * `CG` - Congo * `CK` - Cook Islands * `CO` - Colombia * `KM` - Comoros * `CV` - Cabo Verde * `CR` - Costa Rica * `CU` - Cuba * `CW` - Curaçao * `CX` - Christmas Island * `KY` - Cayman Islands * `CY` - Cyprus * `CZ` - Czechia * `DE` - Germany * `DJ` - Djibouti * `DM` - Dominica * `DK` - Denmark * `DO` - Dominican Republic * `DZ` - Algeria * `EC` - Ecuador * `EG` - Egypt * `ER` - Eritrea * `EH` - Western Sahara * `ES` - Spain * `EE` - Estonia * `ET` - Ethiopia * `FI` - Finland * `FJ` - Fiji * `FK` - Falkland Islands (Malvinas) * `FR` - France * `FO` - Faroe Islands * `FM` - Micronesia, Federated States of * `GA` - Gabon * `GB` - United Kingdom * `GE` - Georgia * `GG` - Guernsey * `GH` - Ghana * `GI` - Gibraltar * `GN` - Guinea * `GP` - Guadeloupe * `GM` - Gambia * `GW` - Guinea-Bissau * `GQ` - Equatorial Guinea * `GR` - Greece * `GD` - Grenada * `GL` - Greenland * `GT` - Guatemala * `GF` - French Guiana * `GU` - Guam * `GY` - Guyana * `HK` - Hong Kong * `HM` - Heard Island and McDonald Islands * `HN` - Honduras * `HR` - Croatia * `HT` - Haiti * `HU` - Hungary * `ID` - Indonesia * `IM` - Isle of Man * `IN` - India * `IO` - British Indian Ocean Territory * `IE` - Ireland * `IR` - Iran, Islamic Republic of * `IQ` - Iraq * `IS` - Iceland * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JE` - Jersey * `JO` - Jordan * `JP` - Japan * `KZ` - Kazakhstan * `KE` - Kenya * `KG` - Kyrgyzstan * `KH` - Cambodia * `KI` - Kiribati * `KN` - Saint Kitts and Nevis * `KR` - Korea, Republic of * `KW` - Kuwait * `LA` - Lao People's Democratic Republic * `LB` - Lebanon * `LR` - Liberia * `LY` - Libya * `LC` - Saint Lucia * `LI` - Liechtenstein * `LK` - Sri Lanka * `LS` - Lesotho * `LT` - Lithuania * `LU` - Luxembourg * `LV` - Latvia * `MO` - Macao * `MF` - Saint Martin (French part) * `MA` - Morocco * `MC` - Monaco * `MD` - Moldova, Republic of * `MG` - Madagascar * `MV` - Maldives * `MX` - Mexico * `MH` - Marshall Islands * `MK` - North Macedonia * `ML` - Mali * `MT` - Malta * `MM` - Myanmar * `ME` - Montenegro * `MN` - Mongolia * `MP` - Northern Mariana Islands * `MZ` - Mozambique * `MR` - Mauritania * `MS` - Montserrat * `MQ` - Martinique * `MU` - Mauritius * `MW` - Malawi * `MY` - Malaysia * `YT` - Mayotte * `NA` - Namibia * `NC` - New Caledonia * `NE` - Niger * `NF` - Norfolk Island * `NG` - Nigeria * `NI` - Nicaragua * `NU` - Niue * `NL` - Netherlands * `NO` - Norway * `NP` - Nepal * `NR` - Nauru * `NZ` - New Zealand * `OM` - Oman * `PK` - Pakistan * `PA` - Panama * `PN` - Pitcairn * `PE` - Peru * `PH` - Philippines * `PW` - Palau * `PG` - Papua New Guinea * `PL` - Poland * `PR` - Puerto Rico * `KP` - Korea, Democratic People's Republic of * `PT` - Portugal * `PY` - Paraguay * `PS` - Palestine, State of * `PF` - French Polynesia * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russian Federation * `RW` - Rwanda * `SA` - Saudi Arabia * `SD` - Sudan * `SN` - Senegal * `SG` - Singapore * `GS` - South Georgia and the South Sandwich Islands * `SH` - Saint Helena, Ascension and Tristan da Cunha * `SJ` - Svalbard and Jan Mayen * `SB` - Solomon Islands * `SL` - Sierra Leone * `SV` - El Salvador * `SM` - San Marino * `SO` - Somalia * `PM` - Saint Pierre and Miquelon * `RS` - Serbia * `SS` - South Sudan * `ST` - Sao Tome and Principe * `SR` - Suriname * `SK` - Slovakia * `SI` - Slovenia * `SE` - Sweden * `SZ` - Eswatini * `SX` - Sint Maarten (Dutch part) * `SC` - Seychelles * `SY` - Syrian Arab Republic * `TC` - Turks and Caicos Islands * `TD` - Chad * `TG` - Togo * `TH` - Thailand * `TJ` - Tajikistan * `TK` - Tokelau * `TM` - Turkmenistan * `TL` - Timor-Leste * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TV` - Tuvalu * `TW` - Taiwan, Province of China * `TZ` - Tanzania, United Republic of * `UG` - Uganda * `UA` - Ukraine * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `US` - United States * `UZ` - Uzbekistan * `VA` - Holy See (Vatican City State) * `VC` - Saint Vincent and the Grenadines * `VE` - Venezuela, Bolivarian Republic of * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `VN` - Viet Nam * `VU` - Vanuatu * `WF` - Wallis and Futuna * `WS` - Samoa * `YE` - Yemen * `ZA` - South Africa * `ZM` - Zambia * `ZW` - Zimbabwe line1: type: string description: Address line 1 (e.g., street, PO Box, or company name) maxLength: 100 line2: type: string nullable: true description: Address line 2 (e.g., apartment, suite, unit, or building) postal_code: type: string description: ZIP or postal code maxLength: 20 state: type: string nullable: true description: State, county, province, or region maxLength: 30 required: - city - country - line1 - postal_code AddressRequest: type: object properties: city: type: string minLength: 1 description: City, district, suburb, town, or village maxLength: 50 country: enum: - AW - AF - AO - AI - AX - AL - AD - AE - AR - AM - AS - AQ - TF - AG - AU - AT - AZ - BI - BE - BJ - BQ - BF - BD - BG - BH - BS - BA - BL - BY - BZ - BM - BO - BR - BB - BN - BT - BV - BW - CF - CA - CC - CH - CL - CN - CI - CM - CD - CG - CK - CO - KM - CV - CR - CU - CW - CX - KY - CY - CZ - DE - DJ - DM - DK - DO - DZ - EC - EG - ER - EH - ES - EE - ET - FI - FJ - FK - FR - FO - FM - GA - GB - GE - GG - GH - GI - GN - GP - GM - GW - GQ - GR - GD - GL - GT - GF - GU - GY - HK - HM - HN - HR - HT - HU - ID - IM - IN - IO - IE - IR - IQ - IS - IL - IT - JM - JE - JO - JP - KZ - KE - KG - KH - KI - KN - KR - KW - LA - LB - LR - LY - LC - LI - LK - LS - LT - LU - LV - MO - MF - MA - MC - MD - MG - MV - MX - MH - MK - ML - MT - MM - ME - MN - MP - MZ - MR - MS - MQ - MU - MW - MY - YT - NA - NC - NE - NF - NG - NI - NU - NL - NO - NP - NR - NZ - OM - PK - PA - PN - PE - PH - PW - PG - PL - PR - KP - PT - PY - PS - PF - QA - RE - RO - RU - RW - SA - SD - SN - SG - GS - SH - SJ - SB - SL - SV - SM - SO - PM - RS - SS - ST - SR - SK - SI - SE - SZ - SX - SC - SY - TC - TD - TG - TH - TJ - TK - TM - TL - TO - TT - TN - TR - TV - TW - TZ - UG - UA - UM - UY - US - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - ZA - ZM - ZW type: string description: |- Two-letter country code (ISO 3166-1 alpha-2) * `AW` - Aruba * `AF` - Afghanistan * `AO` - Angola * `AI` - Anguilla * `AX` - Åland Islands * `AL` - Albania * `AD` - Andorra * `AE` - United Arab Emirates * `AR` - Argentina * `AM` - Armenia * `AS` - American Samoa * `AQ` - Antarctica * `TF` - French Southern Territories * `AG` - Antigua and Barbuda * `AU` - Australia * `AT` - Austria * `AZ` - Azerbaijan * `BI` - Burundi * `BE` - Belgium * `BJ` - Benin * `BQ` - Bonaire, Sint Eustatius and Saba * `BF` - Burkina Faso * `BD` - Bangladesh * `BG` - Bulgaria * `BH` - Bahrain * `BS` - Bahamas * `BA` - Bosnia and Herzegovina * `BL` - Saint Barthélemy * `BY` - Belarus * `BZ` - Belize * `BM` - Bermuda * `BO` - Bolivia, Plurinational State of * `BR` - Brazil * `BB` - Barbados * `BN` - Brunei Darussalam * `BT` - Bhutan * `BV` - Bouvet Island * `BW` - Botswana * `CF` - Central African Republic * `CA` - Canada * `CC` - Cocos (Keeling) Islands * `CH` - Switzerland * `CL` - Chile * `CN` - China * `CI` - Côte d'Ivoire * `CM` - Cameroon * `CD` - Congo, The Democratic Republic of the * `CG` - Congo * `CK` - Cook Islands * `CO` - Colombia * `KM` - Comoros * `CV` - Cabo Verde * `CR` - Costa Rica * `CU` - Cuba * `CW` - Curaçao * `CX` - Christmas Island * `KY` - Cayman Islands * `CY` - Cyprus * `CZ` - Czechia * `DE` - Germany * `DJ` - Djibouti * `DM` - Dominica * `DK` - Denmark * `DO` - Dominican Republic * `DZ` - Algeria * `EC` - Ecuador * `EG` - Egypt * `ER` - Eritrea * `EH` - Western Sahara * `ES` - Spain * `EE` - Estonia * `ET` - Ethiopia * `FI` - Finland * `FJ` - Fiji * `FK` - Falkland Islands (Malvinas) * `FR` - France * `FO` - Faroe Islands * `FM` - Micronesia, Federated States of * `GA` - Gabon * `GB` - United Kingdom * `GE` - Georgia * `GG` - Guernsey * `GH` - Ghana * `GI` - Gibraltar * `GN` - Guinea * `GP` - Guadeloupe * `GM` - Gambia * `GW` - Guinea-Bissau * `GQ` - Equatorial Guinea * `GR` - Greece * `GD` - Grenada * `GL` - Greenland * `GT` - Guatemala * `GF` - French Guiana * `GU` - Guam * `GY` - Guyana * `HK` - Hong Kong * `HM` - Heard Island and McDonald Islands * `HN` - Honduras * `HR` - Croatia * `HT` - Haiti * `HU` - Hungary * `ID` - Indonesia * `IM` - Isle of Man * `IN` - India * `IO` - British Indian Ocean Territory * `IE` - Ireland * `IR` - Iran, Islamic Republic of * `IQ` - Iraq * `IS` - Iceland * `IL` - Israel * `IT` - Italy * `JM` - Jamaica * `JE` - Jersey * `JO` - Jordan * `JP` - Japan * `KZ` - Kazakhstan * `KE` - Kenya * `KG` - Kyrgyzstan * `KH` - Cambodia * `KI` - Kiribati * `KN` - Saint Kitts and Nevis * `KR` - Korea, Republic of * `KW` - Kuwait * `LA` - Lao People's Democratic Republic * `LB` - Lebanon * `LR` - Liberia * `LY` - Libya * `LC` - Saint Lucia * `LI` - Liechtenstein * `LK` - Sri Lanka * `LS` - Lesotho * `LT` - Lithuania * `LU` - Luxembourg * `LV` - Latvia * `MO` - Macao * `MF` - Saint Martin (French part) * `MA` - Morocco * `MC` - Monaco * `MD` - Moldova, Republic of * `MG` - Madagascar * `MV` - Maldives * `MX` - Mexico * `MH` - Marshall Islands * `MK` - North Macedonia * `ML` - Mali * `MT` - Malta * `MM` - Myanmar * `ME` - Montenegro * `MN` - Mongolia * `MP` - Northern Mariana Islands * `MZ` - Mozambique * `MR` - Mauritania * `MS` - Montserrat * `MQ` - Martinique * `MU` - Mauritius * `MW` - Malawi * `MY` - Malaysia * `YT` - Mayotte * `NA` - Namibia * `NC` - New Caledonia * `NE` - Niger * `NF` - Norfolk Island * `NG` - Nigeria * `NI` - Nicaragua * `NU` - Niue * `NL` - Netherlands * `NO` - Norway * `NP` - Nepal * `NR` - Nauru * `NZ` - New Zealand * `OM` - Oman * `PK` - Pakistan * `PA` - Panama * `PN` - Pitcairn * `PE` - Peru * `PH` - Philippines * `PW` - Palau * `PG` - Papua New Guinea * `PL` - Poland * `PR` - Puerto Rico * `KP` - Korea, Democratic People's Republic of * `PT` - Portugal * `PY` - Paraguay * `PS` - Palestine, State of * `PF` - French Polynesia * `QA` - Qatar * `RE` - Réunion * `RO` - Romania * `RU` - Russian Federation * `RW` - Rwanda * `SA` - Saudi Arabia * `SD` - Sudan * `SN` - Senegal * `SG` - Singapore * `GS` - South Georgia and the South Sandwich Islands * `SH` - Saint Helena, Ascension and Tristan da Cunha * `SJ` - Svalbard and Jan Mayen * `SB` - Solomon Islands * `SL` - Sierra Leone * `SV` - El Salvador * `SM` - San Marino * `SO` - Somalia * `PM` - Saint Pierre and Miquelon * `RS` - Serbia * `SS` - South Sudan * `ST` - Sao Tome and Principe * `SR` - Suriname * `SK` - Slovakia * `SI` - Slovenia * `SE` - Sweden * `SZ` - Eswatini * `SX` - Sint Maarten (Dutch part) * `SC` - Seychelles * `SY` - Syrian Arab Republic * `TC` - Turks and Caicos Islands * `TD` - Chad * `TG` - Togo * `TH` - Thailand * `TJ` - Tajikistan * `TK` - Tokelau * `TM` - Turkmenistan * `TL` - Timor-Leste * `TO` - Tonga * `TT` - Trinidad and Tobago * `TN` - Tunisia * `TR` - Turkey * `TV` - Tuvalu * `TW` - Taiwan, Province of China * `TZ` - Tanzania, United Republic of * `UG` - Uganda * `UA` - Ukraine * `UM` - United States Minor Outlying Islands * `UY` - Uruguay * `US` - United States * `UZ` - Uzbekistan * `VA` - Holy See (Vatican City State) * `VC` - Saint Vincent and the Grenadines * `VE` - Venezuela, Bolivarian Republic of * `VG` - Virgin Islands, British * `VI` - Virgin Islands, U.S. * `VN` - Viet Nam * `VU` - Vanuatu * `WF` - Wallis and Futuna * `WS` - Samoa * `YE` - Yemen * `ZA` - South Africa * `ZM` - Zambia * `ZW` - Zimbabwe line1: type: string minLength: 1 description: Address line 1 (e.g., street, PO Box, or company name) maxLength: 100 line2: type: string nullable: true minLength: 1 description: Address line 2 (e.g., apartment, suite, unit, or building) postal_code: type: string minLength: 1 description: ZIP or postal code maxLength: 20 state: type: string nullable: true minLength: 1 description: State, county, province, or region maxLength: 30 required: - city - country - line1 - postal_code AllSubstitutionResults: type: object properties: substitution_results: type: array items: $ref: '#/components/schemas/SingleSubstitution' original_plans_revenue: type: number format: double new_plans_revenue: type: number format: double pct_revenue_change: type: number format: double nullable: true AnalysisDetail: type: object properties: end_date: type: string format: date status: enum: - running - completed - failed type: string description: |- * `running` - Running * `completed` - Completed * `failed` - Failed analysis_results: allOf: - $ref: '#/components/schemas/AnalysisResults' readOnly: true kpis: type: array items: enum: - total_revenue - average_revenue - new_revenue - total_cost - profit - churn type: string description: |- * `total_revenue` - Total Revenue * `average_revenue` - Average Revenue * `new_revenue` - New Revenue * `total_cost` - Total Cost * `profit` - Profit * `churn` - Churn time_created: type: string format: date-time analysis_id: type: string analysis_name: type: string start_date: type: string format: date required: - analysis_id - analysis_name - analysis_results - end_date - start_date AnalysisResults: type: object properties: analysis_summary: type: array items: $ref: '#/components/schemas/SinglePlanAnalysis' revenue_per_day_graph: type: array items: $ref: '#/components/schemas/RevenuePerDay' revenue_by_metric_graph: type: array items: $ref: '#/components/schemas/RevenueByPlanMetric' top_customers_by_plan: type: array items: $ref: '#/components/schemas/TopCustomersPerPlanAnalysis' required: - analysis_summary - revenue_by_metric_graph - revenue_per_day_graph - top_customers_by_plan AnalysisSummary: type: object properties: analysis_name: type: string start_date: type: string format: date end_date: type: string format: date time_created: type: string format: date-time kpis: type: array items: enum: - total_revenue - average_revenue - new_revenue - total_cost - profit - churn type: string description: |- * `total_revenue` - Total Revenue * `average_revenue` - Average Revenue * `new_revenue` - New Revenue * `total_cost` - Total Cost * `profit` - Profit * `churn` - Churn status: enum: - running - completed - failed type: string description: |- * `running` - Running * `completed` - Completed * `failed` - Failed analysis_id: type: string required: - analysis_id - analysis_name - end_date - start_date BacktestCreate: type: object properties: start_date: type: string format: date end_date: type: string format: date kpis: type: array items: enum: - total_revenue type: string description: '* `total_revenue` - Total Revenue' backtest_name: type: string maxLength: 100 required: - backtest_name - end_date - kpis - start_date BacktestCreateRequest: type: object properties: start_date: type: string format: date end_date: type: string format: date substitutions: type: array items: $ref: '#/components/schemas/BacktestSubstitutionMultiRequest' writeOnly: true kpis: type: array items: enum: - total_revenue type: string description: '* `total_revenue` - Total Revenue' backtest_name: type: string minLength: 1 maxLength: 100 required: - backtest_name - end_date - kpis - start_date - substitutions BacktestDetail: type: object properties: backtest_substitutions: type: array items: $ref: '#/components/schemas/BacktestSubstitution' time_created: type: string format: date-time backtest_results: $ref: '#/components/schemas/AllSubstitutionResults' backtest_id: type: string backtest_name: type: string maxLength: 100 start_date: type: string format: date kpis: type: object additionalProperties: {} end_date: type: string format: date status: enum: - running - completed - failed type: string description: |- * `running` - Running * `completed` - Completed * `failed` - Failed required: - backtest_id - backtest_name - backtest_results - backtest_substitutions - end_date - start_date BacktestSubstitution: type: object properties: new_plan: $ref: '#/components/schemas/PlanVersionDetail' original_plan: $ref: '#/components/schemas/PlanVersionDetail' required: - new_plan - original_plan BacktestSubstitutionMulti: type: object properties: new_plan: type: string format: uuid original_plans: type: array items: type: string format: uuid required: - new_plan - original_plans BacktestSubstitutionMultiRequest: type: object properties: new_plan: type: string format: uuid original_plans: type: array items: type: string format: uuid required: - new_plan - original_plans BacktestSummary: type: object properties: backtest_name: type: string maxLength: 100 start_date: type: string format: date end_date: type: string format: date time_created: type: string format: date-time kpis: type: object additionalProperties: {} status: enum: - running - completed - failed type: string description: |- * `running` - Running * `completed` - Completed * `failed` - Failed backtest_id: type: string required: - backtest_id - backtest_name - end_date - start_date CRMSyncRequestRequest: type: object properties: crm_provider_names: type: array items: enum: - salesforce type: string description: '* `salesforce` - salesforce' CategoricalFilter: type: object properties: property_name: type: string maxLength: 100 operator: enum: - isin - isnotin type: string description: |- * `isin` - Is in * `isnotin` - Is not in comparison_value: type: array items: type: string required: - comparison_value - operator - property_name CategoricalFilterDetailRequest: type: object properties: property_name: type: string minLength: 1 maxLength: 100 operator: enum: - isin - isnotin type: string description: |- * `isin` - Is in * `isnotin` - Is not in comparison_value: type: array items: type: string minLength: 1 required: - comparison_value - operator - property_name CategoricalFilterRequest: type: object properties: property_name: type: string minLength: 1 maxLength: 100 operator: enum: - isin - isnotin type: string description: |- * `isin` - Is in * `isnotin` - Is not in comparison_value: type: array items: type: string minLength: 1 required: - comparison_value - operator - property_name ChangeActiveDateResponse: type: object properties: success: type: boolean message: type: string required: - message - success ChangeActiveDatesRequest: type: object properties: version_ids: type: array items: type: string format: uuid description: The version_ids of the plan versions you want to add the feature to. If you want to apply to all versions, use the all_versions parameter. all_versions: type: boolean default: false description: Whether or not to apply this feature to all versions of the feature. If you want to apply to specific versions, use the version_ids parameter. active_from: type: string format: date-time nullable: true description: The date and time that the feature should be active from. If you want to make this inactive, you can pass null here. active_to: type: string format: date-time nullable: true description: The date and time that the feature should be active until. If you want to make this active indefinitely, you can pass null here. ChangePrepaidUnitsRequest: type: object properties: units: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true description: The new prepaid units for the customer. invoice_now: type: boolean default: true description: Whether or not to immediately invoice the customer for the change in prepaid units. required: - units ChangeUserOrganizationRequestRequest: type: object properties: transfer_to_organization_id: type: string minLength: 1 description: The organization ID to transfer to required: - transfer_to_organization_id ComponentCharge: type: object properties: units: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true description: The number of units to charge for. If left null, then it will be required at subscription create time. charge_behavior: enum: - prorate - full description: |- * `prorate` - prorate * `full` - full readOnly: true required: - charge_behavior - units ComponentChargeCreateRequest: type: object properties: units: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true description: The number of units to charge for. If left null, then it will be required at subscription create time. charge_behavior: enum: - prorate - full description: |- * `prorate` - prorate * `full` - full required: - charge_behavior - units ComponentUsage: type: object properties: event_name: type: string description: The name of the event you are checking access for. metric_name: type: string description: The name of the metric. metric_id: type: string description: The metric_id of the metric. This metric_id can be found in the Lotus frontend if you haven't seen it before. metric_usage: type: number format: double description: The current usage of the metric. Keep in mind the current usage of the metric can be different from the billable usage of the metric. metric_free_limit: type: number format: double nullable: true description: If you specified a free tier of usage for this metric, this is the amount of usage that is free. Will be null if you did not specify a free tier for this metric. metric_total_limit: type: number format: double nullable: true description: The total limit of the metric. Will be null if you did not specify a limit for this metric. required: - event_name - metric_free_limit - metric_id - metric_name - metric_total_limit - metric_usage ComponentsFixedChargeInitialValueRequest: type: object properties: metric_id: type: string format: uuid writeOnly: true description: The id of the metric that this initial value is for units: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true description: The number of units of the metric that this initial value is for required: - metric_id - units ConfirmConnected: type: object properties: organization_id: type: string required: - organization_id ConfirmIdemsReceived: type: object properties: status: enum: - success type: string description: '* `success` - success' ids_not_found: type: array items: type: string required: - ids_not_found - status ConfirmIdemsReceivedFailure: type: object properties: status: enum: - failure type: string description: '* `failure` - failure' error: type: string required: - error - status ConfirmIdemsReceivedRequestRequest: type: object properties: idempotency_ids: type: array items: type: string minLength: 1 number_days_lookback: type: integer default: 30 customer_id: type: string minLength: 1 required: - idempotency_ids CostAnalysis: type: object properties: per_day: type: array items: $ref: '#/components/schemas/SingleDayCostAnalysis' total_cost: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true total_revenue: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true profit_margin: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true markup: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - markup - per_day - profit_margin - total_cost - total_revenue CreditDrawdown: type: object properties: credit_id: type: string amount: type: number format: double maximum: 0 minimum: -10000000000 exclusiveMinimum: true description: type: string nullable: true applied_at: type: string format: date-time required: - amount - applied_at - credit_id Customer: type: object properties: customer_id: type: string email: type: string format: email nullable: true customer_name: type: string readOnly: true nullable: true description: The display name of the customer invoices: type: array items: $ref: '#/components/schemas/LightweightInvoice' readOnly: true total_amount_due: type: number format: double readOnly: true subscriptions: type: array items: $ref: '#/components/schemas/SubscriptionRecord' readOnly: true integrations: allOf: - $ref: '#/components/schemas/CustomerIntegrations' readOnly: true description: A dictionary containing the customer's integrations. Keys are the integration type, and the value is a dictionary containing the integration's properties, which can vary by integration. default_currency: $ref: '#/components/schemas/PricingUnit' payment_provider: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true payment_provider_id: type: string nullable: true readOnly: true has_payment_method: type: boolean readOnly: true address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true deprecated: true billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true tax_rate: type: number format: double maximum: 1000 minimum: -1000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC tax_providers: type: array items: enum: - taxjar - lotus - netsuite description: |- * `taxjar` - taxjar * `lotus` - lotus * `netsuite` - netsuite readOnly: true description: A list of tax providers that are enabled for this customer. The list is ordered, meaning we will succesively try to calculate taxes using each provider until we find one that works. required: - billing_address - customer_id - customer_name - default_currency - email - has_payment_method - integrations - invoices - payment_provider - payment_provider_id - shipping_address - subscriptions - tax_providers - tax_rate - timezone - total_amount_due CustomerBalanceAdjustment: type: object properties: credit_id: type: string customer: $ref: '#/components/schemas/LightweightCustomer' amount: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true amount_remaining: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true readOnly: true currency: $ref: '#/components/schemas/PricingUnit' description: type: string readOnly: true nullable: true effective_at: type: string format: date-time readOnly: true expires_at: type: string format: date-time readOnly: true nullable: true status: enum: - active - inactive type: string description: |- * `active` - Active * `inactive` - Inactive readOnly: true amount_paid: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true amount_paid_currency: allOf: - $ref: '#/components/schemas/PricingUnit' nullable: true drawdowns: type: array items: $ref: '#/components/schemas/CreditDrawdown' readOnly: true required: - amount - amount_paid - amount_paid_currency - amount_remaining - credit_id - currency - customer - description - drawdowns - effective_at - expires_at - status CustomerBalanceAdjustmentCreateRequest: type: object properties: customer_id: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true writeOnly: true currency_code: type: string minLength: 1 writeOnly: true description: type: string writeOnly: true nullable: true effective_at: type: string format: date-time writeOnly: true expires_at: type: string format: date-time writeOnly: true nullable: true amount_paid: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true amount_paid_currency_code: type: string minLength: 1 writeOnly: true required: - amount - currency_code - customer_id CustomerBalanceAdjustmentUpdateRequest: type: object properties: description: type: string nullable: true expires_at: type: string format: date-time nullable: true CustomerBraintreeIntegration: type: object properties: braintree_id: type: string has_payment_method: type: boolean required: - braintree_id - has_payment_method CustomerCreateRequest: type: object properties: customer_name: type: string nullable: true description: The display name of the customer maxLength: 100 customer_id: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend email: type: string format: email minLength: 1 description: The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider payment_provider: enum: - stripe - braintree type: string description: |- The payment provider this customer is associated with. Currently, only Stripe is supported. * `stripe` - Stripe * `braintree` - Braintree payment_provider_id: type: string writeOnly: true nullable: true minLength: 1 description: The customer's ID in the specified payment provider. Please note that payment_provider and payment_provider_id are mutually necessary. properties: type: object additionalProperties: {} nullable: true description: Extra metadata for the customer default_currency_code: type: string minLength: 1 writeOnly: true description: The currency code this customer will be invoiced in. Codes are 3 letters, e.g. 'USD'. address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true deprecated: true billing_address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true tax_rate: type: number format: double maximum: 999.999900000000025102053768932819366455078125 minimum: 0 nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% required: - customer_id - email CustomerCreatedRequest: type: object properties: payload: $ref: '#/components/schemas/CustomerRequest' required: - payload CustomerDeleteResponse: type: object properties: customer_id: type: string deleted: type: string format: date-time email: type: string format: email nullable: true num_subscriptions_deleted: type: integer num_addons_deleted: type: integer required: - customer_id - deleted - email - num_addons_deleted - num_subscriptions_deleted CustomerDetail: type: object properties: timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true deprecated: true default_currency: $ref: '#/components/schemas/PricingUnit' shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true crm_provider_url: type: string format: uri nullable: true readOnly: true invoices: type: array items: $ref: '#/components/schemas/LightweightInvoiceDetail' readOnly: true email: type: string format: email nullable: true payment_provider_id: type: string nullable: true readOnly: true has_payment_method: type: boolean readOnly: true upcoming_subscriptions: type: array items: $ref: '#/components/schemas/SubscriptionRecord' readOnly: true crm_provider_id: type: string nullable: true readOnly: true billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true total_amount_due: type: number format: double readOnly: true integrations: allOf: - $ref: '#/components/schemas/CustomerIntegrations' readOnly: true description: A dictionary containing the customer's integrations. Keys are the integration type, and the value is a dictionary containing the integration's properties, which can vary by integration. stripe_subscriptions: type: array items: $ref: '#/components/schemas/StripeSubscriptionRecord' readOnly: true crm_provider: enum: - salesforce type: string description: '* `salesforce` - salesforce' readOnly: true payment_provider: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true payment_provider_url: type: string format: uri nullable: true readOnly: true customer_name: type: string readOnly: true nullable: true description: The display name of the customer subscriptions: type: array items: $ref: '#/components/schemas/SubscriptionRecord' readOnly: true tax_providers: type: array items: enum: - taxjar - lotus - netsuite description: |- * `taxjar` - taxjar * `lotus` - lotus * `netsuite` - netsuite readOnly: true description: A list of tax providers that are enabled for this customer. The list is ordered, meaning we will succesively try to calculate taxes using each provider until we find one that works. customer_id: type: string tax_rate: type: number format: double maximum: 1000 minimum: -1000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% required: - address - billing_address - crm_provider - crm_provider_id - crm_provider_url - customer_id - customer_name - default_currency - email - has_payment_method - integrations - invoices - payment_provider - payment_provider_id - payment_provider_url - shipping_address - stripe_subscriptions - subscriptions - tax_providers - tax_rate - timezone - total_amount_due - upcoming_subscriptions CustomerIntegrations: type: object properties: stripe: allOf: - $ref: '#/components/schemas/CustomerStripeIntegration' nullable: true braintree: allOf: - $ref: '#/components/schemas/CustomerBraintreeIntegration' nullable: true CustomerRequest: type: object properties: customer_id: type: string minLength: 1 email: type: string format: email nullable: true minLength: 1 default_currency: $ref: '#/components/schemas/PricingUnitRequest' payment_provider: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC required: - customer_id - default_currency - email - payment_provider - timezone CustomerStripeIntegration: type: object properties: stripe_id: type: string has_payment_method: type: boolean required: - has_payment_method - stripe_id CustomerSummary: type: object properties: customer_name: type: string nullable: true description: The display name of the customer maxLength: 100 customer_id: type: string nullable: true description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend subscriptions: type: array items: $ref: '#/components/schemas/SubscriptionCustomerSummary' readOnly: true required: - subscriptions CustomerUpdate: type: object properties: default_currency_code: type: string billing_address: allOf: - $ref: '#/components/schemas/Address' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/Address' nullable: true tax_rate: type: number format: double maximum: 999.999900000000025102053768932819366455078125 minimum: 0 nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC customer_name: type: string required: - default_currency_code - timezone CustomerWithRevenue: type: object properties: customer_id: type: string nullable: true description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend total_amount_due: type: number format: double readOnly: true required: - total_amount_due DayMetricUsage: type: object properties: date: type: string format: date customer_usages: type: object additionalProperties: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - customer_usages - date DeleteAddOn: type: object properties: success: type: boolean message: type: string required: - message - success DeleteAddOnVersion: type: object properties: success: type: boolean message: type: string required: - message - success DeletePlan: type: object properties: success: type: boolean message: type: string required: - message - success DeletePlanVersion: type: object properties: success: type: boolean message: type: string required: - message - success DemoLoginFailure: type: object properties: detail: type: string required: - detail DemoLoginRequestRequest: type: object properties: username: type: string minLength: 1 password: type: string minLength: 1 required: - password - username DemoLoginSuccess: type: object properties: detail: type: string token: type: string user: $ref: '#/components/schemas/User' required: - detail - token - user DemoRegistrationDetailRequest: type: object properties: email: type: string minLength: 1 password: type: string minLength: 1 username: type: string minLength: 1 required: - email - password - username DemoRegistrationFailure: type: object properties: detail: type: string required: - detail DemoRegistrationRequest: type: object properties: register: $ref: '#/components/schemas/DemoRegistrationDetailRequest' required: - register DemoRegistrationSuccess: type: object properties: detail: type: string token: type: string user: $ref: '#/components/schemas/User' required: - detail - token - user EmailRequest: type: object properties: email: type: string format: email minLength: 1 required: - email EventDetail: type: object properties: event_name: type: string description: String name of the event, corresponds to definition in metrics properties: type: object additionalProperties: {} description: Extra metadata on the event that can be filtered and queried on in the metrics. All key value pairs should have string keys and values can be either strings or numbers. Place subscription filters in this object to specify which subscription the event should be tracked under time_created: type: string format: date-time description: The time that the event occured, represented as a datetime in RFC3339 in the UTC timezome. idempotency_id: type: string description: A unique identifier for the specific event being passed in. Passing in a unique id allows Lotus to make sure no double counting occurs. We recommend using a UUID4. customer_id: type: string description: The id of the customer that this event is associated with, usually the customer id in your backend required: - customer_id - event_name - idempotency_id - time_created EventProperties: type: object properties: event_names: type: array items: type: string event_name_to_props: type: object additionalProperties: type: array items: type: string required: - event_name_to_props - event_names ExternalPlanLink: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree external_plan_id: type: string maxLength: 100 required: - external_plan_id - source ExternalPlanLinkRequest: type: object properties: plan_id: type: string format: uuid writeOnly: true source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree external_plan_id: type: string minLength: 1 maxLength: 100 required: - external_plan_id - plan_id - source Feature: type: object properties: feature_id: type: string feature_name: type: string readOnly: true feature_description: type: string readOnly: true nullable: true required: - feature_description - feature_id - feature_name FeatureAccessPerSubscription: type: object properties: subscription: $ref: '#/components/schemas/AccessMethodsSubscriptionRecord' access: type: boolean required: - access - subscription FeatureAccessResponse: type: object properties: customer: $ref: '#/components/schemas/LightweightCustomer' access: type: boolean description: Whether or not the customer has access to this feature. The default behavior for this is whether any of the customer's plans have access to this feature. If you have specified subscription filters, then this will be whether any of the customer's plans that match the subscription filters have access to this feature. You can customize the behavior of this flag by setting a policy in your Organization settings in the frontend. feature: $ref: '#/components/schemas/Feature' access_per_subscription: type: array items: $ref: '#/components/schemas/FeatureAccessPerSubscription' required: - access - access_per_subscription - customer - feature FeatureCreateRequest: type: object properties: feature_name: type: string minLength: 1 maxLength: 50 feature_description: type: string nullable: true required: - feature_name FeatureDetail: type: object properties: feature_id: type: string feature_name: type: string readOnly: true feature_description: type: string readOnly: true nullable: true required: - feature_description - feature_id - feature_name GetEventAccess: type: object properties: plan_id: type: string description: The plan_id of the plan we are checking that has access to this feature. subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' description: The subscription filters that are applied to this plan's relationship with the customer. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you. usage_per_component: type: array items: $ref: '#/components/schemas/ComponentUsage' description: "The usage of each component of the plan the customer is on.\ \ Only components that match the request will be included: If metric_id\ \ is provided, this will be a list of length 1. If event_name is provided,\ \ this will be a list of length 1 or more depending on how many components\ \ of the customer's plan use this event." required: - plan_id - subscription_filters - usage_per_component GetFeatureAccess: type: object properties: feature_name: type: string description: Name of the feature to check access for. plan_id: type: string description: The plan_id of the plan we are checking that has access to this feature. subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' description: The subscription filters that are applied to this plan's relationship with the customer. If your billing model does not have the ability multiple plans or subscriptions per customer, this is likely not relevant for you. access: type: boolean description: Whether or not the plan has access to this feature. If your customer can have multiple plans or subscriptions, then you must check the 'access' across all returned plans to determine if the customer can access this feature. required: - access - feature_name - plan_id - subscription_filters ImportCustomerFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status ImportCustomerSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status ImportCustomersRequestRequest: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree required: - source ImportPaymentObjectFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status ImportPaymentObjectSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status ImportPaymentObjectsRequestRequest: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree required: - source ImportSubscriptionsFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status ImportSubscriptionsRequestRequest: type: object properties: source: enum: - stripe type: string description: '* `stripe` - Stripe' required: - source ImportSubscriptionsSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status InitResetPasswordSuccess: type: object properties: email: type: string required: - email InitialAddOnVersionCreateRequest: type: object properties: recurring_charges: type: array items: $ref: '#/components/schemas/RecurringChargeCreateRequest' nullable: true billing_frequency: enum: - one_time - recurring description: |- * `one_time` - one_time * `recurring` - recurring currency_code: type: string minLength: 1 invoice_when: enum: - invoice_on_attach - invoice_on_subscription_end description: |- * `invoice_on_attach` - invoice_on_attach * `invoice_on_subscription_end` - invoice_on_subscription_end features: type: array items: type: string format: uuid components: type: array items: $ref: '#/components/schemas/PlanComponentCreateRequest' nullable: true required: - billing_frequency - currency_code - invoice_when InitialExternalPlanLink: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree external_plan_id: type: string maxLength: 100 required: - external_plan_id - source InitialExternalPlanLinkRequest: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree external_plan_id: type: string minLength: 1 maxLength: 100 required: - external_plan_id - source InitialPlanVersionCreateRequest: type: object properties: version: type: integer price_adjustment: $ref: '#/components/schemas/PriceAdjustmentRequest' month_anchor: type: integer maximum: 12 minimum: 1 writeOnly: true nullable: true recurring_charges: type: array items: $ref: '#/components/schemas/RecurringChargeCreateRequest' currency_code: type: string minLength: 1 localized_name: type: string writeOnly: true nullable: true day_anchor: type: integer maximum: 31 minimum: 1 writeOnly: true nullable: true make_active: type: boolean default: false features: type: array items: type: string format: uuid make_active_type: enum: - replace_on_renewal - grandfather type: string description: |- * `replace_on_renewal` - Replace on Renewal * `grandfather` - Grandfather default: replace_on_renewal components: type: array items: $ref: '#/components/schemas/PlanComponentCreateRequest' target_customer_ids: type: array items: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: - currency_code - version InviteLinkResponse: type: object properties: email: type: string format: email link: type: string format: uri required: - email - link InviteRequestRequest: type: object properties: email: type: string format: email minLength: 1 required: - email InviteResponse: type: object properties: email: type: string format: email required: - email Invoice: type: object properties: invoice_id: type: string invoice_number: type: string readOnly: true cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true currency: $ref: '#/components/schemas/PricingUnit' issue_date: type: string format: date-time readOnly: true payment_status: enum: - draft - voided - paid - unpaid description: |- * `draft` - draft * `voided` - voided * `paid` - paid * `unpaid` - unpaid readOnly: true external_payment_obj_id: type: string readOnly: true nullable: true external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_status: type: string nullable: true line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItem' customer: $ref: '#/components/schemas/LightweightCustomerSerializerForInvoice' due_date: type: string format: date-time readOnly: true nullable: true start_date: type: string format: date readOnly: true end_date: type: string format: date readOnly: true seller: $ref: '#/components/schemas/Seller' invoice_pdf: type: string format: uri readOnly: true nullable: true required: - amount - cost_due - currency - customer - due_date - end_date - external_payment_obj_id - external_payment_obj_type - invoice_id - invoice_number - invoice_pdf - issue_date - line_items - payment_status - seller - start_date InvoiceCreatedRequest: type: object properties: payload: $ref: '#/components/schemas/InvoiceRequest' required: - payload InvoiceDetail: type: object properties: invoice_id: type: string line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItem' seller: $ref: '#/components/schemas/Seller' payment_status: enum: - draft - voided - paid - unpaid description: |- * `draft` - draft * `voided` - voided * `paid` - paid * `unpaid` - unpaid readOnly: true amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true currency: $ref: '#/components/schemas/PricingUnit' cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true crm_provider_url: type: string format: uri nullable: true readOnly: true start_date: type: string format: date readOnly: true end_date: type: string format: date readOnly: true crm_provider_id: type: string nullable: true readOnly: true customer: $ref: '#/components/schemas/LightweightCustomerSerializerForInvoice' external_payment_obj_url: type: string format: uri nullable: true readOnly: true invoice_pdf: type: string format: uri readOnly: true nullable: true external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_id: type: string readOnly: true nullable: true invoice_number: type: string readOnly: true crm_provider: enum: - salesforce type: string description: '* `salesforce` - salesforce' readOnly: true due_date: type: string format: date-time readOnly: true nullable: true issue_date: type: string format: date-time readOnly: true external_payment_obj_status: type: string nullable: true required: - amount - cost_due - crm_provider - crm_provider_id - crm_provider_url - currency - customer - due_date - end_date - external_payment_obj_id - external_payment_obj_type - external_payment_obj_url - invoice_id - invoice_number - invoice_pdf - issue_date - line_items - payment_status - seller - start_date InvoiceDetailRequest: type: object properties: invoice_id: type: string minLength: 1 line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItemRequest' seller: $ref: '#/components/schemas/SellerRequest' currency: $ref: '#/components/schemas/PricingUnitRequest' cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_status: type: string nullable: true required: - cost_due - currency - external_payment_obj_type - invoice_id - line_items - seller InvoiceLineItem: type: object properties: name: type: string maxLength: 100 start_date: type: string format: date-time end_date: type: string format: date-time quantity: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true billing_type: enum: - in_arrears - intermediate - in_advance - one_time - type: string description: |- * `in_arrears` - In Arrears * `intermediate` - Intermediate * `in_advance` - In Advance * `one_time` - One Time nullable: true metadata: type: object additionalProperties: {} nullable: true plan: allOf: - $ref: '#/components/schemas/LightweightPlanVersion' nullable: true readOnly: true subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' nullable: true readOnly: true base: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true description: Base price of the line item. This is the price before any adjustments are applied. adjustments: type: array items: $ref: '#/components/schemas/InvoiceLineItemAdjustment' readOnly: true amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true description: Amount of the line item. This is the price after any adjustments are applied. subtotal: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true deprecated: true required: - adjustments - amount - base - billing_type - end_date - metadata - name - plan - quantity - start_date - subscription_filters - subtotal InvoiceLineItemAdjustment: type: object properties: amount: type: string format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,10})?$ account: type: string readOnly: true adjustment_type: enum: - sales_tax - plan_adjustment description: |- * `sales_tax` - sales_tax * `plan_adjustment` - plan_adjustment readOnly: true required: - account - adjustment_type - amount InvoiceLineItemRequest: type: object properties: name: type: string minLength: 1 maxLength: 100 start_date: type: string format: date-time end_date: type: string format: date-time quantity: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true billing_type: enum: - in_arrears - intermediate - in_advance - one_time - type: string description: |- * `in_arrears` - In Arrears * `intermediate` - Intermediate * `in_advance` - In Advance * `one_time` - One Time nullable: true metadata: type: object additionalProperties: {} nullable: true base: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true description: Base price of the line item. This is the price before any adjustments are applied. amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true description: Amount of the line item. This is the price after any adjustments are applied. subtotal: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true deprecated: true required: - amount - base - billing_type - end_date - metadata - name - quantity - start_date - subtotal InvoicePaidRequest: type: object properties: payload: $ref: '#/components/schemas/InvoiceRequest' required: - payload InvoicePastDueRequest: type: object properties: payload: $ref: '#/components/schemas/InvoiceRequest' required: - payload InvoicePayment: type: object properties: invoice_id: type: string invoice_number: type: string readOnly: true customer: $ref: '#/components/schemas/LightweightCustomerSerializerForInvoice' amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true currency: $ref: '#/components/schemas/PricingUnit' payment_date: type: string format: date-time readOnly: true source: enum: - stripe - braintree - lotus_out_of_band type: string description: |- * `stripe` - stripe * `braintree` - braintree * `lotus_out_of_band` - lotus_out_of_band readOnly: true required: - amount - currency - customer - invoice_id - invoice_number - payment_date - source InvoiceRequest: type: object properties: invoice_id: type: string minLength: 1 cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true currency: $ref: '#/components/schemas/PricingUnitRequest' external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_status: type: string nullable: true line_items: type: array items: $ref: '#/components/schemas/InvoiceLineItemRequest' seller: $ref: '#/components/schemas/SellerRequest' required: - cost_due - currency - external_payment_obj_type - invoice_id - line_items - seller LightweightAddOn: type: object properties: addon_name: type: string description: The name of the add-on plan. addon_id: type: string description: The ID of the add-on plan. addon_type: enum: - flat - usage_based type: string readOnly: true billing_frequency: enum: - one_time - recurring description: |- * `one_time` - one_time * `recurring` - recurring readOnly: true required: - addon_id - addon_name - addon_type - billing_frequency LightweightAddOnRequest: type: object properties: addon_name: type: string minLength: 1 description: The name of the add-on plan. addon_id: type: string minLength: 1 description: The ID of the add-on plan. required: - addon_id - addon_name LightweightAddOnSubscriptionRecord: type: object properties: addon_subscription_id: type: string start_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. addon: $ref: '#/components/schemas/LightweightAddOn' fully_billed: type: boolean readOnly: true required: - addon - addon_subscription_id - end_date - fully_billed - start_date LightweightAddOnSubscriptionRecordRequest: type: object properties: addon_subscription_id: type: string minLength: 1 addon: $ref: '#/components/schemas/LightweightAddOnRequest' required: - addon - addon_subscription_id LightweightCustomer: type: object properties: customer_name: type: string readOnly: true nullable: true description: The display name of the customer email: type: string format: email readOnly: true nullable: true description: The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider customer_id: type: string readOnly: true nullable: true description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: - customer_id - customer_name - email LightweightCustomerSerializerForInvoice: type: object properties: customer_name: type: string readOnly: true nullable: true description: The display name of the customer email: type: string format: email readOnly: true nullable: true description: The primary email address of the customer, must be the same as the email address used to create the customer in the payment provider customer_id: type: string readOnly: true nullable: true description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true required: - customer_id - customer_name - email LightweightInvoice: type: object properties: invoice_id: type: string seller: $ref: '#/components/schemas/Seller' payment_status: enum: - draft - voided - paid - unpaid description: |- * `draft` - draft * `voided` - voided * `paid` - paid * `unpaid` - unpaid readOnly: true amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true currency: $ref: '#/components/schemas/PricingUnit' cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true start_date: type: string format: date readOnly: true end_date: type: string format: date readOnly: true invoice_pdf: type: string format: uri readOnly: true nullable: true external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_id: type: string readOnly: true nullable: true invoice_number: type: string readOnly: true due_date: type: string format: date-time readOnly: true nullable: true issue_date: type: string format: date-time readOnly: true external_payment_obj_status: type: string nullable: true required: - amount - cost_due - currency - due_date - end_date - external_payment_obj_id - invoice_id - invoice_number - invoice_pdf - issue_date - payment_status - seller - start_date - external_payment_obj_type LightweightInvoiceDetail: type: object properties: invoice_id: type: string seller: $ref: '#/components/schemas/Seller' payment_status: enum: - draft - voided - paid - unpaid description: |- * `draft` - draft * `voided` - voided * `paid` - paid * `unpaid` - unpaid readOnly: true cost_due: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true deprecated: true currency: $ref: '#/components/schemas/PricingUnit' amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true readOnly: true crm_provider_url: type: string format: uri nullable: true readOnly: true start_date: type: string format: date readOnly: true end_date: type: string format: date readOnly: true crm_provider_id: type: string nullable: true readOnly: true external_payment_obj_url: type: string format: uri nullable: true readOnly: true invoice_pdf: type: string format: uri readOnly: true nullable: true external_payment_obj_type: enum: - stripe - braintree - type: string description: |- * `stripe` - Stripe * `braintree` - Braintree nullable: true external_payment_obj_id: type: string readOnly: true nullable: true invoice_number: type: string readOnly: true crm_provider: enum: - salesforce type: string description: '* `salesforce` - salesforce' readOnly: true due_date: type: string format: date-time readOnly: true nullable: true issue_date: type: string format: date-time readOnly: true external_payment_obj_status: type: string nullable: true required: - amount - cost_due - crm_provider - crm_provider_id - crm_provider_url - currency - due_date - end_date - external_payment_obj_id - external_payment_obj_type - external_payment_obj_url - invoice_id - invoice_number - invoice_pdf - issue_date - payment_status - seller - start_date LightweightMetric: type: object properties: metric_id: type: string event_name: type: string readOnly: true description: Name of the event that this metric is tracking. metric_name: type: string required: - event_name - metric_id - metric_name LightweightOrganization: type: object properties: organization_id: type: string organization_name: type: string maxLength: 100 organization_type: enum: - Production - Development - Demo - Internal Demo type: string description: |- * `Production` - Production * `Development` - Development * `Demo` - Demo * `Internal Demo` - Internal Demo readOnly: true current: type: boolean readOnly: true required: - current - organization_id - organization_name - organization_type LightweightPlan: type: object properties: plan_name: type: string readOnly: true description: Name of the plan plan_id: type: string required: - plan_id - plan_name LightweightPlanVersion: type: object properties: plan_name: type: string readOnly: true plan_id: type: string version_id: type: string readOnly: true version: oneOf: - type: integer - enum: - custom_version type: string readOnly: true required: - plan_id - plan_name - version - version_id LightweightPlanVersionRequest: type: object properties: plan_id: type: string minLength: 1 required: - plan_id LightweightSubscriptionRecord: type: object properties: fully_billed: type: boolean readOnly: true plan_detail: allOf: - $ref: '#/components/schemas/LightweightPlanVersion' readOnly: true subscription_id: type: string metadata: type: object additionalProperties: {} subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' readOnly: true addons: type: array items: $ref: '#/components/schemas/LightweightAddOnSubscriptionRecord' is_new: type: boolean description: Whether this subscription came from a renewal or from a first-time. Defaults to true on creation. customer: $ref: '#/components/schemas/LightweightCustomer' billing_plan: $ref: '#/components/schemas/LightweightPlanVersion' start_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. required: - addons - auto_renew - billing_plan - customer - end_date - fully_billed - is_new - metadata - plan_detail - start_date - subscription_filters - subscription_id LightweightSubscriptionRecordRequest: type: object properties: subscription_id: type: string minLength: 1 metadata: type: object additionalProperties: {} addons: type: array items: $ref: '#/components/schemas/LightweightAddOnSubscriptionRecordRequest' is_new: type: boolean description: Whether this subscription came from a renewal or from a first-time. Defaults to true on creation. billing_plan: $ref: '#/components/schemas/LightweightPlanVersionRequest' start_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. required: - addons - auto_renew - billing_plan - end_date - is_new - metadata - start_date - subscription_id LightweightUser: type: object properties: username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email maxLength: 254 required: - email - username LinkTokenResponse: type: object properties: link_token: type: string description: The token used to link Vessel and the CRM required: - link_token LoginFailure: type: object properties: detail: type: string required: - detail LoginRequestRequest: type: object properties: username: type: string minLength: 1 password: type: string minLength: 1 required: - password - username LoginSuccess: type: object properties: detail: type: string token: type: string user: $ref: '#/components/schemas/User' required: - detail - token - user LogoutFailure: type: object properties: detail: type: string required: - detail LogoutSuccess: type: object properties: detail: type: string required: - detail MakePublicRequestRequest: type: object properties: version: type: integer minimum: 1 required: - version MakePublicResponse: type: object properties: success: type: boolean message: type: string required: - message - success MakeReplaceWithRequest: type: object properties: versions_to_replace: type: array items: type: string format: uuid description: The plan versions that will get replaced by the current version. required: - versions_to_replace MakeReplaceWithResponse: type: object properties: success: type: boolean message: type: string required: - message - success Metric: type: object properties: metric_id: type: string event_name: type: string readOnly: true description: Name of the event that this metric is tracking. property_name: type: string readOnly: true nullable: true description: The name of the property of the event that should be used for this metric. Doesn't apply if the metric is of type 'counter' with an aggregation of count. aggregation_type: type: string granularity: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string readOnly: true nullable: true description: |- The granularity of the metric. Only applies to metrics of type 'gauge' or 'rate'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total event_type: enum: - delta - total - type: string readOnly: true nullable: true description: |- Used only for metrics of type 'gauge'. Please refer to our documentation for an explanation of the different types. * `delta` - Delta * `total` - Total metric_type: enum: - counter - rate - custom - gauge type: string readOnly: true description: |- The type of metric that this is. Please refer to our documentation for an explanation of the different types. * `counter` - Counter * `rate` - Rate * `custom` - Custom * `gauge` - Gauge metric_name: type: string numeric_filters: type: array items: $ref: '#/components/schemas/NumericFilter' categorical_filters: type: array items: $ref: '#/components/schemas/CategoricalFilter' is_cost_metric: type: boolean readOnly: true description: Whether or not this metric is a cost metric (used to track costs to your business). custom_sql: type: string readOnly: true nullable: true description: A custom SQL query that can be used to define the metric. Please refer to our documentation for more information. proration: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string readOnly: true nullable: true description: |- The proration of the metric. Only applies to metrics of type 'gauge'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total required: - aggregation_type - categorical_filters - custom_sql - event_name - event_type - granularity - is_cost_metric - metric_id - metric_name - metric_type - numeric_filters - property_name - proration MetricAccessPerSubscription: type: object properties: subscription: $ref: '#/components/schemas/AccessMethodsSubscriptionRecord' metric_usage: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true description: The current usage of the metric. Keep in mind the current usage of the metric can be different from the billable usage of the metric. For examnple, for a gauge metric, the `metric_usage` is the current value of the gauge, while the billable usage is the accumulated tiem at each gauge level at the end of the subscription. metric_free_limit: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true description: If you specified a free tier of usage for this metric, this is the amount of usage that is free. Will be 0 if you didn't specify a free limit for this metric or this subscription doesn't have access to this metric, and null if the free tier is unlimited. metric_total_limit: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true description: The total limit of the metric. Will be 0 if this subscription doesn't have access to this metric, and null if there is no limit to this metric. required: - metric_free_limit - metric_total_limit - metric_usage - subscription MetricAccessResponse: type: object properties: customer: $ref: '#/components/schemas/LightweightCustomer' access: type: boolean description: Whether or not the customer has access to this metric. The default behavior for this is whether all of the customer's plans (that have access to the metric) are below the total limit of the metric. If you have specified subscription filters, then this will be whether all of the customer's plans that match the subscription filters are below the total limit of the metric. You can customize the behavior of this flag by setting a policy in your Organization settings in the frontend. metric: $ref: '#/components/schemas/LightweightMetric' access_per_subscription: type: array items: $ref: '#/components/schemas/MetricAccessPerSubscription' required: - access - access_per_subscription - customer - metric MetricCreateRequest: type: object properties: event_name: type: string writeOnly: true minLength: 1 description: Name of the event that this metric is tracking. maxLength: 50 property_name: type: string writeOnly: true nullable: true minLength: 1 description: The name of the property of the event that should be used for this metric. Doesn't apply if the metric is of type 'counter' with an aggregation of count. maxLength: 50 usage_aggregation_type: enum: - count - sum - max - unique - latest - average - type: string writeOnly: true nullable: true description: |- The type of aggregation that should be used for this metric. Please refer to our documentation for an explanation of the different types. * `count` - Count * `sum` - Sum * `max` - Max * `unique` - Unique * `latest` - Latest * `average` - Average billable_aggregation_type: enum: - count - sum - max - unique - latest - average - type: string description: |- * `count` - Count * `sum` - Sum * `max` - Max * `unique` - Unique * `latest` - Latest * `average` - Average writeOnly: true nullable: true granularity: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string writeOnly: true nullable: true description: |- The granularity of the metric. Only applies to metrics of type 'gauge' or 'rate'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total event_type: enum: - delta - total - type: string writeOnly: true nullable: true description: |- Used only for metrics of type 'gauge'. Please refer to our documentation for an explanation of the different types. * `delta` - Delta * `total` - Total metric_type: enum: - counter - rate - custom - gauge type: string writeOnly: true description: |- The type of metric that this is. Please refer to our documentation for an explanation of the different types. * `counter` - Counter * `rate` - Rate * `custom` - Custom * `gauge` - Gauge metric_name: type: string minLength: 1 proration: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string writeOnly: true nullable: true description: |- The proration of the metric. Only applies to metrics of type 'gauge'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total properties: type: object additionalProperties: {} writeOnly: true nullable: true is_cost_metric: type: boolean writeOnly: true default: false description: Whether or not this metric is a cost metric (used to track costs to your business). custom_sql: type: string writeOnly: true nullable: true description: A custom SQL query that can be used to define the metric. Please refer to our documentation for more information. categorical_filters: type: array items: $ref: '#/components/schemas/CategoricalFilterDetailRequest' numeric_filters: type: array items: $ref: '#/components/schemas/NumericFilterDetailRequest' required: - metric_name - metric_type MetricDetail: type: object properties: metric_name: type: string numeric_filters: type: array items: $ref: '#/components/schemas/NumericFilter' is_cost_metric: type: boolean readOnly: true description: Whether or not this metric is a cost metric (used to track costs to your business). proration: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string readOnly: true nullable: true description: |- The proration of the metric. Only applies to metrics of type 'gauge'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total event_name: type: string readOnly: true description: Name of the event that this metric is tracking. metric_type: enum: - counter - rate - custom - gauge type: string readOnly: true description: |- The type of metric that this is. Please refer to our documentation for an explanation of the different types. * `counter` - Counter * `rate` - Rate * `custom` - Custom * `gauge` - Gauge granularity: enum: - seconds - minutes - hours - days - months - quarters - years - total - type: string readOnly: true nullable: true description: |- The granularity of the metric. Only applies to metrics of type 'gauge' or 'rate'. * `seconds` - Second * `minutes` - Minute * `hours` - Hour * `days` - Day * `months` - Month * `quarters` - Quarter * `years` - Year * `total` - Total property_name: type: string readOnly: true nullable: true description: The name of the property of the event that should be used for this metric. Doesn't apply if the metric is of type 'counter' with an aggregation of count. event_type: enum: - delta - total - type: string readOnly: true nullable: true description: |- Used only for metrics of type 'gauge'. Please refer to our documentation for an explanation of the different types. * `delta` - Delta * `total` - Total metric_id: type: string custom_sql: type: string readOnly: true nullable: true description: A custom SQL query that can be used to define the metric. Please refer to our documentation for more information. categorical_filters: type: array items: $ref: '#/components/schemas/CategoricalFilter' usage_aggregation_type: enum: - count - sum - max - unique - latest - average type: string description: |- The type of aggregation that should be used for this metric. Please refer to our documentation for an explanation of the different types. * `count` - Count * `sum` - Sum * `max` - Max * `unique` - Unique * `latest` - Latest * `average` - Average billable_aggregation_type: enum: - count - sum - max - unique - latest - average - '' - type: string description: |- * `count` - Count * `sum` - Sum * `max` - Max * `unique` - Unique * `latest` - Latest * `average` - Average nullable: true required: - categorical_filters - custom_sql - event_name - event_type - granularity - is_cost_metric - metric_id - metric_name - metric_type - numeric_filters - property_name - proration MetricRequest: type: object properties: metric_id: type: string minLength: 1 aggregation_type: type: string minLength: 1 metric_name: type: string minLength: 1 numeric_filters: type: array items: $ref: '#/components/schemas/NumericFilterRequest' categorical_filters: type: array items: $ref: '#/components/schemas/CategoricalFilterRequest' required: - aggregation_type - categorical_filters - metric_id - metric_name - numeric_filters MetricRevenue: type: object properties: metric_name: type: string original_plan_revenue: type: number format: double new_plan_revenue: type: number format: double required: - metric_name - new_plan_revenue - original_plan_revenue MetricUpdate: type: object properties: billable_metric_name: type: string nullable: true maxLength: 50 status: enum: - active - archived type: string description: |- * `active` - Active * `archived` - Archived NextPlanVersionNumberResponse: type: object properties: version: type: integer required: - version NumericFilter: type: object properties: property_name: type: string maxLength: 100 operator: enum: - gte - gt - eq - lt - lte type: string description: |- * `gte` - Greater than or equal to * `gt` - Greater than * `eq` - Equal to * `lt` - Less than * `lte` - Less than or equal to comparison_value: type: number format: double required: - comparison_value - operator - property_name NumericFilterDetailRequest: type: object properties: property_name: type: string minLength: 1 maxLength: 100 operator: enum: - gte - gt - eq - lt - lte type: string description: |- * `gte` - Greater than or equal to * `gt` - Greater than * `eq` - Equal to * `lt` - Less than * `lte` - Less than or equal to comparison_value: type: number format: double required: - comparison_value - operator - property_name NumericFilterRequest: type: object properties: property_name: type: string minLength: 1 maxLength: 100 operator: enum: - gte - gt - eq - lt - lte type: string description: |- * `gte` - Greater than or equal to * `gt` - Greater than * `eq` - Equal to * `lt` - Less than * `lte` - Less than or equal to comparison_value: type: number format: double required: - comparison_value - operator - property_name Organization: type: object properties: organization_id: type: string organization_name: type: string maxLength: 100 users: type: array items: $ref: '#/components/schemas/OrganizationUser' readOnly: true default_currency: $ref: '#/components/schemas/PricingUnitDetail' available_currencies: type: array items: $ref: '#/components/schemas/PricingUnitDetail' readOnly: true plan_tags: type: array items: $ref: '#/components/schemas/Tag' readOnly: true tax_rate: type: number format: double maximum: 999.999900000000025102053768932819366455078125 minimum: 0 nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% payment_grace_period: type: string readOnly: true linked_organizations: type: array items: $ref: '#/components/schemas/LightweightOrganization' readOnly: true current_user: allOf: - $ref: '#/components/schemas/LightweightUser' readOnly: true address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true team_name: type: string readOnly: true subscription_filter_keys: type: array items: type: string description: Allowed subscription filter keys timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC stripe_account_id: type: string nullable: true readOnly: true braintree_merchant_id: type: string nullable: true readOnly: true tax_providers: type: array items: enum: - taxjar - lotus - netsuite description: |- * `taxjar` - taxjar * `lotus` - lotus * `netsuite` - netsuite readOnly: true crm_integration_allowed: type: boolean gen_cust_in_stripe_after_lotus: type: boolean gen_cust_in_braintree_after_lotus: type: boolean lotus_is_customer_source_for_salesforce: type: boolean required: - address - available_currencies - braintree_merchant_id - crm_integration_allowed - current_user - default_currency - linked_organizations - organization_id - organization_name - payment_grace_period - plan_tags - stripe_account_id - tax_providers - team_name - timezone - users OrganizationCreateRequest: type: object properties: organization_name: type: string minLength: 1 maxLength: 100 default_currency_code: type: string minLength: 1 organization_type: enum: - development - production type: string description: |- * `development` - development * `production` - production default: development required: - organization_name OrganizationUser: type: object properties: username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email maxLength: 254 role: type: string readOnly: true status: enum: - Active - Invited type: string description: |- * `Active` - Active * `Invited` - Invited default: Active required: - email - role - username PaginatedActionList: type: object properties: next: type: string nullable: true previous: type: string nullable: true results: type: array items: $ref: '#/components/schemas/Action' PaginatedEventDetailList: type: object properties: next: type: string nullable: true previous: type: string nullable: true results: type: array items: $ref: '#/components/schemas/EventDetail' PatchedAddOnUpdateRequest: type: object properties: addon_name: type: string minLength: 1 active_from: type: string format: date-time active_to: type: string format: date-time nullable: true PatchedAddOnVersionUpdateRequest: type: object properties: addon_version_name: type: string minLength: 1 active_from: type: string format: date-time nullable: true active_to: type: string format: date-time nullable: true PatchedCustomerUpdateRequest: type: object properties: default_currency_code: type: string minLength: 1 billing_address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true shipping_address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true tax_rate: type: number format: double maximum: 999.999900000000025102053768932819366455078125 minimum: 0 nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC customer_name: type: string minLength: 1 PatchedInvoiceUpdateRequest: type: object properties: payment_status: enum: - paid - unpaid type: string description: |- * `paid` - paid * `unpaid` - unpaid PatchedMetricUpdateRequest: type: object properties: billable_metric_name: type: string nullable: true maxLength: 50 status: enum: - active - archived type: string description: |- * `active` - Active * `archived` - Archived PatchedOrganizationUpdateRequest: type: object properties: default_currency_code: type: string minLength: 1 address: allOf: - $ref: '#/components/schemas/AddressRequest' nullable: true tax_rate: type: number format: double maximum: 999.999900000000025102053768932819366455078125 minimum: 0 writeOnly: true nullable: true description: Tax rate as percentage. For example, 10.5 for 10.5% payment_grace_period: type: integer maximum: 365 minimum: 0 nullable: true plan_tags: type: array items: $ref: '#/components/schemas/TagRequest' subscription_filter_keys: type: array items: type: string minLength: 1 timezone: enum: - Africa/Abidjan - Africa/Accra - Africa/Addis_Ababa - Africa/Algiers - Africa/Asmara - Africa/Bamako - Africa/Bangui - Africa/Banjul - Africa/Bissau - Africa/Blantyre - Africa/Brazzaville - Africa/Bujumbura - Africa/Cairo - Africa/Casablanca - Africa/Ceuta - Africa/Conakry - Africa/Dakar - Africa/Dar_es_Salaam - Africa/Djibouti - Africa/Douala - Africa/El_Aaiun - Africa/Freetown - Africa/Gaborone - Africa/Harare - Africa/Johannesburg - Africa/Juba - Africa/Kampala - Africa/Khartoum - Africa/Kigali - Africa/Kinshasa - Africa/Lagos - Africa/Libreville - Africa/Lome - Africa/Luanda - Africa/Lubumbashi - Africa/Lusaka - Africa/Malabo - Africa/Maputo - Africa/Maseru - Africa/Mbabane - Africa/Mogadishu - Africa/Monrovia - Africa/Nairobi - Africa/Ndjamena - Africa/Niamey - Africa/Nouakchott - Africa/Ouagadougou - Africa/Porto-Novo - Africa/Sao_Tome - Africa/Tripoli - Africa/Tunis - Africa/Windhoek - America/Adak - America/Anchorage - America/Anguilla - America/Antigua - America/Araguaina - America/Argentina/Buenos_Aires - America/Argentina/Catamarca - America/Argentina/Cordoba - America/Argentina/Jujuy - America/Argentina/La_Rioja - America/Argentina/Mendoza - America/Argentina/Rio_Gallegos - America/Argentina/Salta - America/Argentina/San_Juan - America/Argentina/San_Luis - America/Argentina/Tucuman - America/Argentina/Ushuaia - America/Aruba - America/Asuncion - America/Atikokan - America/Bahia - America/Bahia_Banderas - America/Barbados - America/Belem - America/Belize - America/Blanc-Sablon - America/Boa_Vista - America/Bogota - America/Boise - America/Cambridge_Bay - America/Campo_Grande - America/Cancun - America/Caracas - America/Cayenne - America/Cayman - America/Chicago - America/Chihuahua - America/Ciudad_Juarez - America/Costa_Rica - America/Creston - America/Cuiaba - America/Curacao - America/Danmarkshavn - America/Dawson - America/Dawson_Creek - America/Denver - America/Detroit - America/Dominica - America/Edmonton - America/Eirunepe - America/El_Salvador - America/Fort_Nelson - America/Fortaleza - America/Glace_Bay - America/Goose_Bay - America/Grand_Turk - America/Grenada - America/Guadeloupe - America/Guatemala - America/Guayaquil - America/Guyana - America/Halifax - America/Havana - America/Hermosillo - America/Indiana/Indianapolis - America/Indiana/Knox - America/Indiana/Marengo - America/Indiana/Petersburg - America/Indiana/Tell_City - America/Indiana/Vevay - America/Indiana/Vincennes - America/Indiana/Winamac - America/Inuvik - America/Iqaluit - America/Jamaica - America/Juneau - America/Kentucky/Louisville - America/Kentucky/Monticello - America/Kralendijk - America/La_Paz - America/Lima - America/Los_Angeles - America/Lower_Princes - America/Maceio - America/Managua - America/Manaus - America/Marigot - America/Martinique - America/Matamoros - America/Mazatlan - America/Menominee - America/Merida - America/Metlakatla - America/Mexico_City - America/Miquelon - America/Moncton - America/Monterrey - America/Montevideo - America/Montserrat - America/Nassau - America/New_York - America/Nome - America/Noronha - America/North_Dakota/Beulah - America/North_Dakota/Center - America/North_Dakota/New_Salem - America/Nuuk - America/Ojinaga - America/Panama - America/Paramaribo - America/Phoenix - America/Port-au-Prince - America/Port_of_Spain - America/Porto_Velho - America/Puerto_Rico - America/Punta_Arenas - America/Rankin_Inlet - America/Recife - America/Regina - America/Resolute - America/Rio_Branco - America/Santarem - America/Santiago - America/Santo_Domingo - America/Sao_Paulo - America/Scoresbysund - America/Sitka - America/St_Barthelemy - America/St_Johns - America/St_Kitts - America/St_Lucia - America/St_Thomas - America/St_Vincent - America/Swift_Current - America/Tegucigalpa - America/Thule - America/Tijuana - America/Toronto - America/Tortola - America/Vancouver - America/Whitehorse - America/Winnipeg - America/Yakutat - America/Yellowknife - Antarctica/Casey - Antarctica/Davis - Antarctica/DumontDUrville - Antarctica/Macquarie - Antarctica/Mawson - Antarctica/McMurdo - Antarctica/Palmer - Antarctica/Rothera - Antarctica/Syowa - Antarctica/Troll - Antarctica/Vostok - Arctic/Longyearbyen - Asia/Aden - Asia/Almaty - Asia/Amman - Asia/Anadyr - Asia/Aqtau - Asia/Aqtobe - Asia/Ashgabat - Asia/Atyrau - Asia/Baghdad - Asia/Bahrain - Asia/Baku - Asia/Bangkok - Asia/Barnaul - Asia/Beirut - Asia/Bishkek - Asia/Brunei - Asia/Chita - Asia/Choibalsan - Asia/Colombo - Asia/Damascus - Asia/Dhaka - Asia/Dili - Asia/Dubai - Asia/Dushanbe - Asia/Famagusta - Asia/Gaza - Asia/Hebron - Asia/Ho_Chi_Minh - Asia/Hong_Kong - Asia/Hovd - Asia/Irkutsk - Asia/Jakarta - Asia/Jayapura - Asia/Jerusalem - Asia/Kabul - Asia/Kamchatka - Asia/Karachi - Asia/Kathmandu - Asia/Khandyga - Asia/Kolkata - Asia/Krasnoyarsk - Asia/Kuala_Lumpur - Asia/Kuching - Asia/Kuwait - Asia/Macau - Asia/Magadan - Asia/Makassar - Asia/Manila - Asia/Muscat - Asia/Nicosia - Asia/Novokuznetsk - Asia/Novosibirsk - Asia/Omsk - Asia/Oral - Asia/Phnom_Penh - Asia/Pontianak - Asia/Pyongyang - Asia/Qatar - Asia/Qostanay - Asia/Qyzylorda - Asia/Riyadh - Asia/Sakhalin - Asia/Samarkand - Asia/Seoul - Asia/Shanghai - Asia/Singapore - Asia/Srednekolymsk - Asia/Taipei - Asia/Tashkent - Asia/Tbilisi - Asia/Tehran - Asia/Thimphu - Asia/Tokyo - Asia/Tomsk - Asia/Ulaanbaatar - Asia/Urumqi - Asia/Ust-Nera - Asia/Vientiane - Asia/Vladivostok - Asia/Yakutsk - Asia/Yangon - Asia/Yekaterinburg - Asia/Yerevan - Atlantic/Azores - Atlantic/Bermuda - Atlantic/Canary - Atlantic/Cape_Verde - Atlantic/Faroe - Atlantic/Madeira - Atlantic/Reykjavik - Atlantic/South_Georgia - Atlantic/St_Helena - Atlantic/Stanley - Australia/Adelaide - Australia/Brisbane - Australia/Broken_Hill - Australia/Darwin - Australia/Eucla - Australia/Hobart - Australia/Lindeman - Australia/Lord_Howe - Australia/Melbourne - Australia/Perth - Australia/Sydney - Canada/Atlantic - Canada/Central - Canada/Eastern - Canada/Mountain - Canada/Newfoundland - Canada/Pacific - Europe/Amsterdam - Europe/Andorra - Europe/Astrakhan - Europe/Athens - Europe/Belgrade - Europe/Berlin - Europe/Bratislava - Europe/Brussels - Europe/Bucharest - Europe/Budapest - Europe/Busingen - Europe/Chisinau - Europe/Copenhagen - Europe/Dublin - Europe/Gibraltar - Europe/Guernsey - Europe/Helsinki - Europe/Isle_of_Man - Europe/Istanbul - Europe/Jersey - Europe/Kaliningrad - Europe/Kirov - Europe/Kyiv - Europe/Lisbon - Europe/Ljubljana - Europe/London - Europe/Luxembourg - Europe/Madrid - Europe/Malta - Europe/Mariehamn - Europe/Minsk - Europe/Monaco - Europe/Moscow - Europe/Oslo - Europe/Paris - Europe/Podgorica - Europe/Prague - Europe/Riga - Europe/Rome - Europe/Samara - Europe/San_Marino - Europe/Sarajevo - Europe/Saratov - Europe/Simferopol - Europe/Skopje - Europe/Sofia - Europe/Stockholm - Europe/Tallinn - Europe/Tirane - Europe/Ulyanovsk - Europe/Vaduz - Europe/Vatican - Europe/Vienna - Europe/Vilnius - Europe/Volgograd - Europe/Warsaw - Europe/Zagreb - Europe/Zurich - GMT - Indian/Antananarivo - Indian/Chagos - Indian/Christmas - Indian/Cocos - Indian/Comoro - Indian/Kerguelen - Indian/Mahe - Indian/Maldives - Indian/Mauritius - Indian/Mayotte - Indian/Reunion - Pacific/Apia - Pacific/Auckland - Pacific/Bougainville - Pacific/Chatham - Pacific/Chuuk - Pacific/Easter - Pacific/Efate - Pacific/Fakaofo - Pacific/Fiji - Pacific/Funafuti - Pacific/Galapagos - Pacific/Gambier - Pacific/Guadalcanal - Pacific/Guam - Pacific/Honolulu - Pacific/Kanton - Pacific/Kiritimati - Pacific/Kosrae - Pacific/Kwajalein - Pacific/Majuro - Pacific/Marquesas - Pacific/Midway - Pacific/Nauru - Pacific/Niue - Pacific/Norfolk - Pacific/Noumea - Pacific/Pago_Pago - Pacific/Palau - Pacific/Pitcairn - Pacific/Pohnpei - Pacific/Port_Moresby - Pacific/Rarotonga - Pacific/Saipan - Pacific/Tahiti - Pacific/Tarawa - Pacific/Tongatapu - Pacific/Wake - Pacific/Wallis - US/Alaska - US/Arizona - US/Central - US/Eastern - US/Hawaii - US/Mountain - US/Pacific - UTC type: string description: |- * `Africa/Abidjan` - Africa/Abidjan * `Africa/Accra` - Africa/Accra * `Africa/Addis_Ababa` - Africa/Addis_Ababa * `Africa/Algiers` - Africa/Algiers * `Africa/Asmara` - Africa/Asmara * `Africa/Bamako` - Africa/Bamako * `Africa/Bangui` - Africa/Bangui * `Africa/Banjul` - Africa/Banjul * `Africa/Bissau` - Africa/Bissau * `Africa/Blantyre` - Africa/Blantyre * `Africa/Brazzaville` - Africa/Brazzaville * `Africa/Bujumbura` - Africa/Bujumbura * `Africa/Cairo` - Africa/Cairo * `Africa/Casablanca` - Africa/Casablanca * `Africa/Ceuta` - Africa/Ceuta * `Africa/Conakry` - Africa/Conakry * `Africa/Dakar` - Africa/Dakar * `Africa/Dar_es_Salaam` - Africa/Dar_es_Salaam * `Africa/Djibouti` - Africa/Djibouti * `Africa/Douala` - Africa/Douala * `Africa/El_Aaiun` - Africa/El_Aaiun * `Africa/Freetown` - Africa/Freetown * `Africa/Gaborone` - Africa/Gaborone * `Africa/Harare` - Africa/Harare * `Africa/Johannesburg` - Africa/Johannesburg * `Africa/Juba` - Africa/Juba * `Africa/Kampala` - Africa/Kampala * `Africa/Khartoum` - Africa/Khartoum * `Africa/Kigali` - Africa/Kigali * `Africa/Kinshasa` - Africa/Kinshasa * `Africa/Lagos` - Africa/Lagos * `Africa/Libreville` - Africa/Libreville * `Africa/Lome` - Africa/Lome * `Africa/Luanda` - Africa/Luanda * `Africa/Lubumbashi` - Africa/Lubumbashi * `Africa/Lusaka` - Africa/Lusaka * `Africa/Malabo` - Africa/Malabo * `Africa/Maputo` - Africa/Maputo * `Africa/Maseru` - Africa/Maseru * `Africa/Mbabane` - Africa/Mbabane * `Africa/Mogadishu` - Africa/Mogadishu * `Africa/Monrovia` - Africa/Monrovia * `Africa/Nairobi` - Africa/Nairobi * `Africa/Ndjamena` - Africa/Ndjamena * `Africa/Niamey` - Africa/Niamey * `Africa/Nouakchott` - Africa/Nouakchott * `Africa/Ouagadougou` - Africa/Ouagadougou * `Africa/Porto-Novo` - Africa/Porto-Novo * `Africa/Sao_Tome` - Africa/Sao_Tome * `Africa/Tripoli` - Africa/Tripoli * `Africa/Tunis` - Africa/Tunis * `Africa/Windhoek` - Africa/Windhoek * `America/Adak` - America/Adak * `America/Anchorage` - America/Anchorage * `America/Anguilla` - America/Anguilla * `America/Antigua` - America/Antigua * `America/Araguaina` - America/Araguaina * `America/Argentina/Buenos_Aires` - America/Argentina/Buenos_Aires * `America/Argentina/Catamarca` - America/Argentina/Catamarca * `America/Argentina/Cordoba` - America/Argentina/Cordoba * `America/Argentina/Jujuy` - America/Argentina/Jujuy * `America/Argentina/La_Rioja` - America/Argentina/La_Rioja * `America/Argentina/Mendoza` - America/Argentina/Mendoza * `America/Argentina/Rio_Gallegos` - America/Argentina/Rio_Gallegos * `America/Argentina/Salta` - America/Argentina/Salta * `America/Argentina/San_Juan` - America/Argentina/San_Juan * `America/Argentina/San_Luis` - America/Argentina/San_Luis * `America/Argentina/Tucuman` - America/Argentina/Tucuman * `America/Argentina/Ushuaia` - America/Argentina/Ushuaia * `America/Aruba` - America/Aruba * `America/Asuncion` - America/Asuncion * `America/Atikokan` - America/Atikokan * `America/Bahia` - America/Bahia * `America/Bahia_Banderas` - America/Bahia_Banderas * `America/Barbados` - America/Barbados * `America/Belem` - America/Belem * `America/Belize` - America/Belize * `America/Blanc-Sablon` - America/Blanc-Sablon * `America/Boa_Vista` - America/Boa_Vista * `America/Bogota` - America/Bogota * `America/Boise` - America/Boise * `America/Cambridge_Bay` - America/Cambridge_Bay * `America/Campo_Grande` - America/Campo_Grande * `America/Cancun` - America/Cancun * `America/Caracas` - America/Caracas * `America/Cayenne` - America/Cayenne * `America/Cayman` - America/Cayman * `America/Chicago` - America/Chicago * `America/Chihuahua` - America/Chihuahua * `America/Ciudad_Juarez` - America/Ciudad_Juarez * `America/Costa_Rica` - America/Costa_Rica * `America/Creston` - America/Creston * `America/Cuiaba` - America/Cuiaba * `America/Curacao` - America/Curacao * `America/Danmarkshavn` - America/Danmarkshavn * `America/Dawson` - America/Dawson * `America/Dawson_Creek` - America/Dawson_Creek * `America/Denver` - America/Denver * `America/Detroit` - America/Detroit * `America/Dominica` - America/Dominica * `America/Edmonton` - America/Edmonton * `America/Eirunepe` - America/Eirunepe * `America/El_Salvador` - America/El_Salvador * `America/Fort_Nelson` - America/Fort_Nelson * `America/Fortaleza` - America/Fortaleza * `America/Glace_Bay` - America/Glace_Bay * `America/Goose_Bay` - America/Goose_Bay * `America/Grand_Turk` - America/Grand_Turk * `America/Grenada` - America/Grenada * `America/Guadeloupe` - America/Guadeloupe * `America/Guatemala` - America/Guatemala * `America/Guayaquil` - America/Guayaquil * `America/Guyana` - America/Guyana * `America/Halifax` - America/Halifax * `America/Havana` - America/Havana * `America/Hermosillo` - America/Hermosillo * `America/Indiana/Indianapolis` - America/Indiana/Indianapolis * `America/Indiana/Knox` - America/Indiana/Knox * `America/Indiana/Marengo` - America/Indiana/Marengo * `America/Indiana/Petersburg` - America/Indiana/Petersburg * `America/Indiana/Tell_City` - America/Indiana/Tell_City * `America/Indiana/Vevay` - America/Indiana/Vevay * `America/Indiana/Vincennes` - America/Indiana/Vincennes * `America/Indiana/Winamac` - America/Indiana/Winamac * `America/Inuvik` - America/Inuvik * `America/Iqaluit` - America/Iqaluit * `America/Jamaica` - America/Jamaica * `America/Juneau` - America/Juneau * `America/Kentucky/Louisville` - America/Kentucky/Louisville * `America/Kentucky/Monticello` - America/Kentucky/Monticello * `America/Kralendijk` - America/Kralendijk * `America/La_Paz` - America/La_Paz * `America/Lima` - America/Lima * `America/Los_Angeles` - America/Los_Angeles * `America/Lower_Princes` - America/Lower_Princes * `America/Maceio` - America/Maceio * `America/Managua` - America/Managua * `America/Manaus` - America/Manaus * `America/Marigot` - America/Marigot * `America/Martinique` - America/Martinique * `America/Matamoros` - America/Matamoros * `America/Mazatlan` - America/Mazatlan * `America/Menominee` - America/Menominee * `America/Merida` - America/Merida * `America/Metlakatla` - America/Metlakatla * `America/Mexico_City` - America/Mexico_City * `America/Miquelon` - America/Miquelon * `America/Moncton` - America/Moncton * `America/Monterrey` - America/Monterrey * `America/Montevideo` - America/Montevideo * `America/Montserrat` - America/Montserrat * `America/Nassau` - America/Nassau * `America/New_York` - America/New_York * `America/Nome` - America/Nome * `America/Noronha` - America/Noronha * `America/North_Dakota/Beulah` - America/North_Dakota/Beulah * `America/North_Dakota/Center` - America/North_Dakota/Center * `America/North_Dakota/New_Salem` - America/North_Dakota/New_Salem * `America/Nuuk` - America/Nuuk * `America/Ojinaga` - America/Ojinaga * `America/Panama` - America/Panama * `America/Paramaribo` - America/Paramaribo * `America/Phoenix` - America/Phoenix * `America/Port-au-Prince` - America/Port-au-Prince * `America/Port_of_Spain` - America/Port_of_Spain * `America/Porto_Velho` - America/Porto_Velho * `America/Puerto_Rico` - America/Puerto_Rico * `America/Punta_Arenas` - America/Punta_Arenas * `America/Rankin_Inlet` - America/Rankin_Inlet * `America/Recife` - America/Recife * `America/Regina` - America/Regina * `America/Resolute` - America/Resolute * `America/Rio_Branco` - America/Rio_Branco * `America/Santarem` - America/Santarem * `America/Santiago` - America/Santiago * `America/Santo_Domingo` - America/Santo_Domingo * `America/Sao_Paulo` - America/Sao_Paulo * `America/Scoresbysund` - America/Scoresbysund * `America/Sitka` - America/Sitka * `America/St_Barthelemy` - America/St_Barthelemy * `America/St_Johns` - America/St_Johns * `America/St_Kitts` - America/St_Kitts * `America/St_Lucia` - America/St_Lucia * `America/St_Thomas` - America/St_Thomas * `America/St_Vincent` - America/St_Vincent * `America/Swift_Current` - America/Swift_Current * `America/Tegucigalpa` - America/Tegucigalpa * `America/Thule` - America/Thule * `America/Tijuana` - America/Tijuana * `America/Toronto` - America/Toronto * `America/Tortola` - America/Tortola * `America/Vancouver` - America/Vancouver * `America/Whitehorse` - America/Whitehorse * `America/Winnipeg` - America/Winnipeg * `America/Yakutat` - America/Yakutat * `America/Yellowknife` - America/Yellowknife * `Antarctica/Casey` - Antarctica/Casey * `Antarctica/Davis` - Antarctica/Davis * `Antarctica/DumontDUrville` - Antarctica/DumontDUrville * `Antarctica/Macquarie` - Antarctica/Macquarie * `Antarctica/Mawson` - Antarctica/Mawson * `Antarctica/McMurdo` - Antarctica/McMurdo * `Antarctica/Palmer` - Antarctica/Palmer * `Antarctica/Rothera` - Antarctica/Rothera * `Antarctica/Syowa` - Antarctica/Syowa * `Antarctica/Troll` - Antarctica/Troll * `Antarctica/Vostok` - Antarctica/Vostok * `Arctic/Longyearbyen` - Arctic/Longyearbyen * `Asia/Aden` - Asia/Aden * `Asia/Almaty` - Asia/Almaty * `Asia/Amman` - Asia/Amman * `Asia/Anadyr` - Asia/Anadyr * `Asia/Aqtau` - Asia/Aqtau * `Asia/Aqtobe` - Asia/Aqtobe * `Asia/Ashgabat` - Asia/Ashgabat * `Asia/Atyrau` - Asia/Atyrau * `Asia/Baghdad` - Asia/Baghdad * `Asia/Bahrain` - Asia/Bahrain * `Asia/Baku` - Asia/Baku * `Asia/Bangkok` - Asia/Bangkok * `Asia/Barnaul` - Asia/Barnaul * `Asia/Beirut` - Asia/Beirut * `Asia/Bishkek` - Asia/Bishkek * `Asia/Brunei` - Asia/Brunei * `Asia/Chita` - Asia/Chita * `Asia/Choibalsan` - Asia/Choibalsan * `Asia/Colombo` - Asia/Colombo * `Asia/Damascus` - Asia/Damascus * `Asia/Dhaka` - Asia/Dhaka * `Asia/Dili` - Asia/Dili * `Asia/Dubai` - Asia/Dubai * `Asia/Dushanbe` - Asia/Dushanbe * `Asia/Famagusta` - Asia/Famagusta * `Asia/Gaza` - Asia/Gaza * `Asia/Hebron` - Asia/Hebron * `Asia/Ho_Chi_Minh` - Asia/Ho_Chi_Minh * `Asia/Hong_Kong` - Asia/Hong_Kong * `Asia/Hovd` - Asia/Hovd * `Asia/Irkutsk` - Asia/Irkutsk * `Asia/Jakarta` - Asia/Jakarta * `Asia/Jayapura` - Asia/Jayapura * `Asia/Jerusalem` - Asia/Jerusalem * `Asia/Kabul` - Asia/Kabul * `Asia/Kamchatka` - Asia/Kamchatka * `Asia/Karachi` - Asia/Karachi * `Asia/Kathmandu` - Asia/Kathmandu * `Asia/Khandyga` - Asia/Khandyga * `Asia/Kolkata` - Asia/Kolkata * `Asia/Krasnoyarsk` - Asia/Krasnoyarsk * `Asia/Kuala_Lumpur` - Asia/Kuala_Lumpur * `Asia/Kuching` - Asia/Kuching * `Asia/Kuwait` - Asia/Kuwait * `Asia/Macau` - Asia/Macau * `Asia/Magadan` - Asia/Magadan * `Asia/Makassar` - Asia/Makassar * `Asia/Manila` - Asia/Manila * `Asia/Muscat` - Asia/Muscat * `Asia/Nicosia` - Asia/Nicosia * `Asia/Novokuznetsk` - Asia/Novokuznetsk * `Asia/Novosibirsk` - Asia/Novosibirsk * `Asia/Omsk` - Asia/Omsk * `Asia/Oral` - Asia/Oral * `Asia/Phnom_Penh` - Asia/Phnom_Penh * `Asia/Pontianak` - Asia/Pontianak * `Asia/Pyongyang` - Asia/Pyongyang * `Asia/Qatar` - Asia/Qatar * `Asia/Qostanay` - Asia/Qostanay * `Asia/Qyzylorda` - Asia/Qyzylorda * `Asia/Riyadh` - Asia/Riyadh * `Asia/Sakhalin` - Asia/Sakhalin * `Asia/Samarkand` - Asia/Samarkand * `Asia/Seoul` - Asia/Seoul * `Asia/Shanghai` - Asia/Shanghai * `Asia/Singapore` - Asia/Singapore * `Asia/Srednekolymsk` - Asia/Srednekolymsk * `Asia/Taipei` - Asia/Taipei * `Asia/Tashkent` - Asia/Tashkent * `Asia/Tbilisi` - Asia/Tbilisi * `Asia/Tehran` - Asia/Tehran * `Asia/Thimphu` - Asia/Thimphu * `Asia/Tokyo` - Asia/Tokyo * `Asia/Tomsk` - Asia/Tomsk * `Asia/Ulaanbaatar` - Asia/Ulaanbaatar * `Asia/Urumqi` - Asia/Urumqi * `Asia/Ust-Nera` - Asia/Ust-Nera * `Asia/Vientiane` - Asia/Vientiane * `Asia/Vladivostok` - Asia/Vladivostok * `Asia/Yakutsk` - Asia/Yakutsk * `Asia/Yangon` - Asia/Yangon * `Asia/Yekaterinburg` - Asia/Yekaterinburg * `Asia/Yerevan` - Asia/Yerevan * `Atlantic/Azores` - Atlantic/Azores * `Atlantic/Bermuda` - Atlantic/Bermuda * `Atlantic/Canary` - Atlantic/Canary * `Atlantic/Cape_Verde` - Atlantic/Cape_Verde * `Atlantic/Faroe` - Atlantic/Faroe * `Atlantic/Madeira` - Atlantic/Madeira * `Atlantic/Reykjavik` - Atlantic/Reykjavik * `Atlantic/South_Georgia` - Atlantic/South_Georgia * `Atlantic/St_Helena` - Atlantic/St_Helena * `Atlantic/Stanley` - Atlantic/Stanley * `Australia/Adelaide` - Australia/Adelaide * `Australia/Brisbane` - Australia/Brisbane * `Australia/Broken_Hill` - Australia/Broken_Hill * `Australia/Darwin` - Australia/Darwin * `Australia/Eucla` - Australia/Eucla * `Australia/Hobart` - Australia/Hobart * `Australia/Lindeman` - Australia/Lindeman * `Australia/Lord_Howe` - Australia/Lord_Howe * `Australia/Melbourne` - Australia/Melbourne * `Australia/Perth` - Australia/Perth * `Australia/Sydney` - Australia/Sydney * `Canada/Atlantic` - Canada/Atlantic * `Canada/Central` - Canada/Central * `Canada/Eastern` - Canada/Eastern * `Canada/Mountain` - Canada/Mountain * `Canada/Newfoundland` - Canada/Newfoundland * `Canada/Pacific` - Canada/Pacific * `Europe/Amsterdam` - Europe/Amsterdam * `Europe/Andorra` - Europe/Andorra * `Europe/Astrakhan` - Europe/Astrakhan * `Europe/Athens` - Europe/Athens * `Europe/Belgrade` - Europe/Belgrade * `Europe/Berlin` - Europe/Berlin * `Europe/Bratislava` - Europe/Bratislava * `Europe/Brussels` - Europe/Brussels * `Europe/Bucharest` - Europe/Bucharest * `Europe/Budapest` - Europe/Budapest * `Europe/Busingen` - Europe/Busingen * `Europe/Chisinau` - Europe/Chisinau * `Europe/Copenhagen` - Europe/Copenhagen * `Europe/Dublin` - Europe/Dublin * `Europe/Gibraltar` - Europe/Gibraltar * `Europe/Guernsey` - Europe/Guernsey * `Europe/Helsinki` - Europe/Helsinki * `Europe/Isle_of_Man` - Europe/Isle_of_Man * `Europe/Istanbul` - Europe/Istanbul * `Europe/Jersey` - Europe/Jersey * `Europe/Kaliningrad` - Europe/Kaliningrad * `Europe/Kirov` - Europe/Kirov * `Europe/Kyiv` - Europe/Kyiv * `Europe/Lisbon` - Europe/Lisbon * `Europe/Ljubljana` - Europe/Ljubljana * `Europe/London` - Europe/London * `Europe/Luxembourg` - Europe/Luxembourg * `Europe/Madrid` - Europe/Madrid * `Europe/Malta` - Europe/Malta * `Europe/Mariehamn` - Europe/Mariehamn * `Europe/Minsk` - Europe/Minsk * `Europe/Monaco` - Europe/Monaco * `Europe/Moscow` - Europe/Moscow * `Europe/Oslo` - Europe/Oslo * `Europe/Paris` - Europe/Paris * `Europe/Podgorica` - Europe/Podgorica * `Europe/Prague` - Europe/Prague * `Europe/Riga` - Europe/Riga * `Europe/Rome` - Europe/Rome * `Europe/Samara` - Europe/Samara * `Europe/San_Marino` - Europe/San_Marino * `Europe/Sarajevo` - Europe/Sarajevo * `Europe/Saratov` - Europe/Saratov * `Europe/Simferopol` - Europe/Simferopol * `Europe/Skopje` - Europe/Skopje * `Europe/Sofia` - Europe/Sofia * `Europe/Stockholm` - Europe/Stockholm * `Europe/Tallinn` - Europe/Tallinn * `Europe/Tirane` - Europe/Tirane * `Europe/Ulyanovsk` - Europe/Ulyanovsk * `Europe/Vaduz` - Europe/Vaduz * `Europe/Vatican` - Europe/Vatican * `Europe/Vienna` - Europe/Vienna * `Europe/Vilnius` - Europe/Vilnius * `Europe/Volgograd` - Europe/Volgograd * `Europe/Warsaw` - Europe/Warsaw * `Europe/Zagreb` - Europe/Zagreb * `Europe/Zurich` - Europe/Zurich * `GMT` - GMT * `Indian/Antananarivo` - Indian/Antananarivo * `Indian/Chagos` - Indian/Chagos * `Indian/Christmas` - Indian/Christmas * `Indian/Cocos` - Indian/Cocos * `Indian/Comoro` - Indian/Comoro * `Indian/Kerguelen` - Indian/Kerguelen * `Indian/Mahe` - Indian/Mahe * `Indian/Maldives` - Indian/Maldives * `Indian/Mauritius` - Indian/Mauritius * `Indian/Mayotte` - Indian/Mayotte * `Indian/Reunion` - Indian/Reunion * `Pacific/Apia` - Pacific/Apia * `Pacific/Auckland` - Pacific/Auckland * `Pacific/Bougainville` - Pacific/Bougainville * `Pacific/Chatham` - Pacific/Chatham * `Pacific/Chuuk` - Pacific/Chuuk * `Pacific/Easter` - Pacific/Easter * `Pacific/Efate` - Pacific/Efate * `Pacific/Fakaofo` - Pacific/Fakaofo * `Pacific/Fiji` - Pacific/Fiji * `Pacific/Funafuti` - Pacific/Funafuti * `Pacific/Galapagos` - Pacific/Galapagos * `Pacific/Gambier` - Pacific/Gambier * `Pacific/Guadalcanal` - Pacific/Guadalcanal * `Pacific/Guam` - Pacific/Guam * `Pacific/Honolulu` - Pacific/Honolulu * `Pacific/Kanton` - Pacific/Kanton * `Pacific/Kiritimati` - Pacific/Kiritimati * `Pacific/Kosrae` - Pacific/Kosrae * `Pacific/Kwajalein` - Pacific/Kwajalein * `Pacific/Majuro` - Pacific/Majuro * `Pacific/Marquesas` - Pacific/Marquesas * `Pacific/Midway` - Pacific/Midway * `Pacific/Nauru` - Pacific/Nauru * `Pacific/Niue` - Pacific/Niue * `Pacific/Norfolk` - Pacific/Norfolk * `Pacific/Noumea` - Pacific/Noumea * `Pacific/Pago_Pago` - Pacific/Pago_Pago * `Pacific/Palau` - Pacific/Palau * `Pacific/Pitcairn` - Pacific/Pitcairn * `Pacific/Pohnpei` - Pacific/Pohnpei * `Pacific/Port_Moresby` - Pacific/Port_Moresby * `Pacific/Rarotonga` - Pacific/Rarotonga * `Pacific/Saipan` - Pacific/Saipan * `Pacific/Tahiti` - Pacific/Tahiti * `Pacific/Tarawa` - Pacific/Tarawa * `Pacific/Tongatapu` - Pacific/Tongatapu * `Pacific/Wake` - Pacific/Wake * `Pacific/Wallis` - Pacific/Wallis * `US/Alaska` - US/Alaska * `US/Arizona` - US/Arizona * `US/Central` - US/Central * `US/Eastern` - US/Eastern * `US/Hawaii` - US/Hawaii * `US/Mountain` - US/Mountain * `US/Pacific` - US/Pacific * `UTC` - UTC payment_provider: enum: - stripe - braintree type: string description: |- To udpate a payment provider's ID, specify the payment provider you want to update in this field, and the payment_provider_id in the corresponding field. * `stripe` - Stripe * `braintree` - Braintree payment_provider_id: type: string minLength: 1 nango_connected: type: boolean tax_providers: type: array items: enum: - taxjar - lotus - netsuite description: |- * `taxjar` - taxjar * `lotus` - lotus * `netsuite` - netsuite nullable: true gen_cust_in_stripe_after_lotus: type: boolean writeOnly: true gen_cust_in_braintree_after_lotus: type: boolean writeOnly: true lotus_is_customer_source_for_salesforce: type: boolean writeOnly: true PatchedPlanUpdateRequest: type: object properties: plan_name: type: string minLength: 1 description: Name of the plan plan_description: type: string nullable: true description: Description of the plan taxjar_code: type: string nullable: true maxLength: 30 active_from: type: string format: date-time active_to: type: string format: date-time nullable: true PatchedPlanVersionUpdateRequest: type: object properties: localized_name: type: string nullable: true active_from: type: string format: date-time nullable: true active_to: type: string format: date-time nullable: true PaymentProcesorPostDataRequest: type: object properties: payment_processor: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree data: type: object additionalProperties: {} required: - data - payment_processor PaymentProcesorPostRequestRequest: type: object properties: pp_info: $ref: '#/components/schemas/PaymentProcesorPostDataRequest' required: - pp_info PaymentProcesorPostResponse: type: object properties: payment_processor: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree success: type: boolean details: type: string required: - details - payment_processor - success PerPlanPerDay: type: object properties: plan: $ref: '#/components/schemas/LightweightPlanVersion' revenue: type: string format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,10})?$ required: - plan - revenue PeriodMetricRevenueResponse: type: object properties: total_revenue: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true earned_revenue: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - earned_revenue - total_revenue PeriodMetricUsageResponse: type: object properties: metrics: type: object additionalProperties: $ref: '#/components/schemas/PeriodSingleMetricUsage' required: - metrics PeriodSingleMetricUsage: type: object properties: data: type: array items: $ref: '#/components/schemas/DayMetricUsage' required: - data PeriodSubscriptionsResponse: type: object properties: period_1_total_subscriptions: type: integer period_1_new_subscriptions: type: integer period_2_total_subscriptions: type: integer period_2_new_subscriptions: type: integer required: - period_1_new_subscriptions - period_1_total_subscriptions - period_2_new_subscriptions - period_2_total_subscriptions Plan: type: object properties: plan_id: type: string plan_name: type: string description: Name of the plan plan_duration: enum: - monthly - quarterly - yearly - type: string nullable: true description: |- Duration of the plan * `monthly` - Monthly * `quarterly` - Quarterly * `yearly` - Yearly plan_description: type: string nullable: true description: Description of the plan external_links: type: array items: $ref: '#/components/schemas/InitialExternalPlanLink' description: The external links that this plan has. num_versions: type: integer readOnly: true description: The number of versions that this plan has. active_version: type: integer readOnly: true description: This plan's currently active version. active_subscriptions: type: integer readOnly: true description: The number of active subscriptions that this plan has across all versions. tags: type: array items: type: string pattern: ^[-a-zA-Z0-9_]+$ readOnly: true description: The tags that this plan has. versions: type: array items: $ref: '#/components/schemas/PlanVersion' description: This plan's versions. parent_plan: allOf: - $ref: '#/components/schemas/PlanNameAndID' nullable: true readOnly: true description: '[DEPRECATED] The parent plan that this plan has.' deprecated: true target_customer: allOf: - $ref: '#/components/schemas/LightweightCustomer' nullable: true readOnly: true description: '[DEPRECATED] The target customer that this plan has.' deprecated: true display_version: allOf: - $ref: '#/components/schemas/PlanVersion' readOnly: true description: "[DEPRECATED] Display version has been deprecated. Use 'versions'\ \ instead. We will still return this field for now with some heuristics\ \ for figuring out what the desired version is, but it will be removed\ \ in the near future." deprecated: true status: type: string readOnly: true description: '[DEPRECATED] The status of this plan.' deprecated: true required: - active_subscriptions - active_version - display_version - external_links - num_versions - plan_description - plan_duration - plan_id - plan_name - status - tags - versions - parent_plan - target_customer PlanComponent: type: object properties: billable_metric: $ref: '#/components/schemas/Metric' tiers: type: array items: $ref: '#/components/schemas/PriceTier' pricing_unit: $ref: '#/components/schemas/PricingUnit' invoicing_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true readOnly: true invoicing_interval_count: type: integer readOnly: true nullable: true reset_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true readOnly: true reset_interval_count: type: integer readOnly: true nullable: true prepaid_charge: allOf: - $ref: '#/components/schemas/ComponentCharge' nullable: true required: - billable_metric - invoicing_interval_count - invoicing_interval_unit - prepaid_charge - pricing_unit - reset_interval_count - reset_interval_unit - tiers PlanComponentCreateRequest: type: object properties: metric_id: type: string format: uuid writeOnly: true tiers: type: array items: $ref: '#/components/schemas/PriceTierCreateRequest' invoicing_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true invoicing_interval_count: type: integer maximum: 32767 minimum: 0 nullable: true reset_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true reset_interval_count: type: integer maximum: 32767 minimum: 0 nullable: true prepaid_charge: allOf: - $ref: '#/components/schemas/ComponentChargeCreateRequest' nullable: true required: - metric_id PlanCreateRequest: type: object properties: plan_name: type: string writeOnly: true minLength: 1 description: Name of the plan plan_description: type: string nullable: true description: Description of the plan plan_duration: enum: - monthly - quarterly - yearly - type: string writeOnly: true nullable: true description: |- Duration of the plan * `monthly` - Monthly * `quarterly` - Quarterly * `yearly` - Yearly initial_external_links: type: array items: $ref: '#/components/schemas/InitialExternalPlanLinkRequest' initial_version: $ref: '#/components/schemas/InitialPlanVersionCreateRequest' tags: type: array items: $ref: '#/components/schemas/TagRequest' required: - initial_version - plan_name PlanDetail: type: object properties: versions: type: array items: $ref: '#/components/schemas/PlanVersionDetail' readOnly: true plan_duration: enum: - monthly - quarterly - yearly - type: string nullable: true description: |- Duration of the plan * `monthly` - Monthly * `quarterly` - Quarterly * `yearly` - Yearly active_subscriptions: type: integer readOnly: true description: The number of active subscriptions that this plan has across all versions. external_links: type: array items: $ref: '#/components/schemas/InitialExternalPlanLink' description: The external links that this plan has. active_version: type: integer readOnly: true description: This plan's currently active version. plan_id: type: string tags: type: array items: $ref: '#/components/schemas/Tag' readOnly: true description: The tags that this plan has. taxjar_code: type: string nullable: true maxLength: 30 num_versions: type: integer readOnly: true description: The number of versions that this plan has. plan_name: type: string description: Name of the plan plan_description: type: string nullable: true description: Description of the plan required: - active_subscriptions - active_version - external_links - num_versions - plan_description - plan_duration - plan_id - plan_name - tags - versions PlanNameAndID: type: object properties: plan_name: type: string description: Name of the plan plan_id: type: string required: - plan_id - plan_name PlanRepresentation: type: object properties: plan_name: type: string plan_id: type: string plan_revenue: type: number format: double required: - plan_id - plan_name - plan_revenue PlanUpdate: type: object properties: plan_name: type: string description: Name of the plan plan_description: type: string nullable: true description: Description of the plan taxjar_code: type: string nullable: true maxLength: 30 active_from: type: string format: date-time active_to: type: string format: date-time nullable: true PlanVersion: type: object properties: recurring_charges: type: array items: $ref: '#/components/schemas/RecurringCharge' readOnly: true components: type: array items: $ref: '#/components/schemas/PlanComponent' features: type: array items: $ref: '#/components/schemas/Feature' price_adjustment: allOf: - $ref: '#/components/schemas/PriceAdjustment' nullable: true version: oneOf: - type: integer - enum: - custom_version type: string readOnly: true status: enum: - active - retiring - grandfathered - deleted - inactive - not_started type: string description: |- * `active` - Active * `retiring` - Retiring * `grandfathered` - Grandfathered * `deleted` - Deleted * `inactive` - Inactive * `not_started` - Not Started readOnly: true plan_name: type: string readOnly: true currency: $ref: '#/components/schemas/PricingUnit' active_from: type: string format: date-time readOnly: true nullable: true active_to: type: string format: date-time readOnly: true nullable: true localized_name: type: string readOnly: true nullable: true target_customers: type: array items: $ref: '#/components/schemas/LightweightCustomer' created_on: type: string format: date-time readOnly: true usage_billing_frequency: type: string nullable: true readOnly: true deprecated: true flat_fee_billing_type: enum: - in_advance - in_arrears type: string description: |- * `in_advance` - in_advance * `in_arrears` - in_arrears readOnly: true deprecated: true flat_rate: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true readOnly: true deprecated: true description: type: string nullable: true readOnly: true deprecated: true required: - active_from - active_to - components - created_on - currency - description - features - flat_fee_billing_type - flat_rate - localized_name - plan_name - price_adjustment - recurring_charges - status - target_customers - usage_billing_frequency - version PlanVersionCreateRequest: type: object properties: plan_id: type: string format: uuid recurring_charges: type: array items: $ref: '#/components/schemas/RecurringChargeCreateRequest' components: type: array items: $ref: '#/components/schemas/PlanComponentCreateRequest' features: type: array items: type: string format: uuid price_adjustment: $ref: '#/components/schemas/PriceAdjustmentRequest' day_anchor: type: integer maximum: 31 minimum: 1 writeOnly: true nullable: true month_anchor: type: integer maximum: 12 minimum: 1 writeOnly: true nullable: true currency_code: type: string minLength: 1 version: type: integer target_customer_ids: type: array items: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend localized_name: type: string writeOnly: true nullable: true make_active: type: boolean default: false make_active_type: enum: - replace_on_renewal - grandfather type: string description: |- * `replace_on_renewal` - Replace on Renewal * `grandfather` - Grandfather default: replace_on_renewal required: - currency_code - plan_id - version PlanVersionDetail: type: object properties: transition_to: $ref: '#/components/schemas/LightweightPlan' active_subscriptions: type: integer readOnly: true status: enum: - active - retiring - grandfathered - deleted - inactive - not_started type: string description: |- * `active` - Active * `retiring` - Retiring * `grandfathered` - Grandfathered * `deleted` - Deleted * `inactive` - Inactive * `not_started` - Not Started readOnly: true localized_name: type: string readOnly: true nullable: true plan_id: type: string readOnly: true currency: $ref: '#/components/schemas/PricingUnit' created_on: type: string format: date-time readOnly: true replace_with: $ref: '#/components/schemas/LightweightPlanVersion' components: type: array items: $ref: '#/components/schemas/PlanComponent' version: oneOf: - type: integer - enum: - custom_version type: string readOnly: true price_adjustment: allOf: - $ref: '#/components/schemas/PriceAdjustment' nullable: true features: type: array items: $ref: '#/components/schemas/Feature' recurring_charges: type: array items: $ref: '#/components/schemas/RecurringCharge' readOnly: true version_id: type: string readOnly: true active_to: type: string format: date-time readOnly: true nullable: true active_from: type: string format: date-time readOnly: true nullable: true alerts: type: array items: $ref: '#/components/schemas/UsageAlert' readOnly: true target_customers: type: array items: $ref: '#/components/schemas/LightweightCustomer' plan_name: type: string readOnly: true required: - active_from - active_subscriptions - active_to - alerts - components - created_on - currency - features - localized_name - plan_id - plan_name - price_adjustment - recurring_charges - replace_with - status - target_customers - transition_to - version - version_id PlanVersionHistoricalSubscription: type: object properties: customer_id: type: string customer_name: type: string start_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time readOnly: true description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean readOnly: true description: Whether the subscription automatically renews. Defaults to true. required: - auto_renew - customer_id - customer_name - end_date - start_date PlanVersionNumberSetReplaceWithResponse: type: object properties: success: type: boolean message: type: string required: - message - success PlanVersionNumberSetTransitionToResponse: type: object properties: success: type: boolean message: type: string required: - message - success PlanVersionUpdate: type: object properties: localized_name: type: string nullable: true active_from: type: string format: date-time nullable: true active_to: type: string format: date-time nullable: true PlansByNumCustomers: type: object properties: results: type: array items: $ref: '#/components/schemas/SinglePlanNumCustomers' status: enum: - success type: string description: '* `success` - success' required: - results - status PlansSetReplaceWithForVersionNumberRequest: type: object properties: replacement_version_number: type: integer minimum: 1 description: The version number of the plan that will replace the current version. required: - replacement_version_number PlansSetTransitionToForVersionNumberRequest: type: object properties: transition_to_plan_id: type: integer description: The plan that the current version will transition to. required: - transition_to_plan_id PriceAdjustment: type: object properties: price_adjustment_name: type: string maxLength: 100 price_adjustment_description: type: string nullable: true price_adjustment_type: enum: - percentage - fixed - price_override type: string description: |- * `percentage` - Percentage * `fixed` - Fixed * `price_override` - Price Override price_adjustment_amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - price_adjustment_amount - price_adjustment_description - price_adjustment_name - price_adjustment_type PriceAdjustmentRequest: type: object properties: price_adjustment_name: type: string minLength: 1 default: '' price_adjustment_description: type: string nullable: true price_adjustment_type: enum: - percentage - fixed - price_override type: string description: |- * `percentage` - Percentage * `fixed` - Fixed * `price_override` - Price Override price_adjustment_amount: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - price_adjustment_amount - price_adjustment_type PriceTier: type: object properties: type: enum: - flat - per_unit - free description: |- * `flat` - flat * `per_unit` - per_unit * `free` - free readOnly: true range_start: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true range_end: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true cost_per_batch: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true metric_units_per_batch: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true batch_rounding_type: enum: - round_up - round_down - round_nearest - no_rounding - description: |- * `round_up` - round_up * `round_down` - round_down * `round_nearest` - round_nearest * `no_rounding` - no_rounding nullable: true readOnly: true required: - batch_rounding_type - cost_per_batch - metric_units_per_batch - range_end - range_start - type PriceTierCreateRequest: type: object properties: type: enum: - flat - per_unit - free type: string description: |- * `flat` - Flat * `per_unit` - Per Unit * `free` - Free range_start: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true range_end: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true cost_per_batch: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true metric_units_per_batch: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true nullable: true batch_rounding_type: enum: - round_up - round_down - round_nearest - no_rounding - type: string description: |- * `round_up` - Round Up * `round_down` - Round Down * `round_nearest` - Round Nearest * `no_rounding` - No Rounding nullable: true default: no_rounding required: - range_start - type PricingUnit: type: object properties: code: type: string maxLength: 10 name: type: string maxLength: 100 symbol: type: string maxLength: 10 required: - code - name - symbol PricingUnitDetail: type: object properties: code: type: string maxLength: 10 name: type: string maxLength: 100 symbol: type: string maxLength: 10 required: - code - name - symbol PricingUnitDetailRequest: type: object properties: code: type: string minLength: 1 maxLength: 10 name: type: string minLength: 1 maxLength: 100 symbol: type: string minLength: 1 maxLength: 10 required: - code - name - symbol PricingUnitRequest: type: object properties: code: type: string minLength: 1 maxLength: 10 name: type: string minLength: 1 maxLength: 100 symbol: type: string minLength: 1 maxLength: 10 required: - code - name - symbol RecurringCharge: type: object properties: name: type: string charge_timing: enum: - in_advance - in_arrears type: string description: |- * `in_advance` - in_advance * `in_arrears` - in_arrears readOnly: true charge_behavior: enum: - prorate - full type: string description: |- * `prorate` - prorate * `full` - full readOnly: true amount: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true pricing_unit: $ref: '#/components/schemas/PricingUnit' invoicing_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true readOnly: true invoicing_interval_count: type: integer maximum: 32767 minimum: 0 nullable: true reset_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true readOnly: true reset_interval_count: type: integer maximum: 32767 minimum: 0 nullable: true required: - amount - charge_behavior - charge_timing - invoicing_interval_count - invoicing_interval_unit - name - pricing_unit - reset_interval_count - reset_interval_unit RecurringChargeCreateRequest: type: object properties: name: type: string minLength: 1 charge_timing: enum: - in_advance - in_arrears type: string description: |- * `in_advance` - in_advance * `in_arrears` - in_arrears charge_behavior: enum: - prorate - full type: string description: |- * `prorate` - prorate * `full` - full default: prorate amount: type: number format: double maximum: 10000000000 minimum: 0 exclusiveMaximum: true pricing_unit_code: type: string minLength: 1 invoicing_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true invoicing_interval_count: type: integer maximum: 32767 minimum: 0 writeOnly: true nullable: true reset_interval_unit: enum: - day - week - month - year - type: string description: |- * `day` - day * `week` - week * `month` - month * `year` - year nullable: true reset_interval_count: type: integer maximum: 32767 minimum: 0 writeOnly: true nullable: true required: - amount - charge_timing - name RegistrationDetailRequest: type: object properties: organization_name: type: string industry: type: string email: type: string minLength: 1 password: type: string minLength: 1 username: type: string minLength: 1 required: - email - industry - organization_name - password - username RegistrationFailure: type: object properties: detail: type: string required: - detail RegistrationRequest: type: object properties: register: $ref: '#/components/schemas/RegistrationDetailRequest' required: - register RegistrationSuccess: type: object properties: detail: type: string token: type: string user: $ref: '#/components/schemas/User' required: - detail - token - user RemovePlanTags: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' success: type: boolean message: type: string required: - message - success RemovePlanTagsRequest: type: object properties: tags: type: array items: $ref: '#/components/schemas/TagRequest' RemoveTargetCustomerResponse: type: object properties: success: type: boolean message: type: string required: - message - success ResetPasswordRequestRequest: type: object properties: userId: type: string minLength: 1 password: type: string minLength: 1 token: type: string minLength: 1 required: - password - token - userId ResetPasswordSuccess: type: object properties: detail: type: string token: type: string required: - detail - token RevenueByMetric: type: object properties: metric: $ref: '#/components/schemas/LightweightMetric' revenue: type: string format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,10})?$ required: - metric - revenue RevenueByPlanMetric: type: object properties: plan: $ref: '#/components/schemas/LightweightPlanVersion' by_metric: type: array items: $ref: '#/components/schemas/RevenueByMetric' required: - by_metric - plan RevenueDate: type: object properties: date: type: string format: date original_plan_revenue: type: number format: double new_plan_revenue: type: number format: double required: - date - new_plan_revenue - original_plan_revenue RevenuePerDay: type: object properties: date: type: string format: date revenue_per_plan: type: array items: $ref: '#/components/schemas/PerPlanPerDay' required: - date - revenue_per_plan Seller: type: object properties: name: type: string address: allOf: - $ref: '#/components/schemas/Address' nullable: true readOnly: true phone: type: string nullable: true maxLength: 20 email: type: string format: email nullable: true maxLength: 254 required: - name SellerRequest: type: object properties: name: type: string minLength: 1 phone: type: string nullable: true maxLength: 20 email: type: string format: email nullable: true maxLength: 254 required: - name SessionSuccess: type: object properties: isAuthenticated: type: boolean required: - isAuthenticated SetPlanTagsRequest: type: object properties: tags: type: array items: $ref: '#/components/schemas/TagRequest' SetPlanTagsResponse: type: object properties: tags: type: array items: $ref: '#/components/schemas/Tag' success: type: boolean message: type: string required: - message - success SetReplaceWithRequest: type: object properties: replace_with: type: string format: uuid description: The plan version to replace the current version with. required: - replace_with SetReplaceWithResponse: type: object properties: success: type: boolean message: type: string required: - message - success SingleCRMProvider: type: object properties: crm_provider_name: enum: - salesforce type: string description: '* `salesforce` - salesforce' connected: type: boolean self_hosted: type: boolean working: type: boolean connection_id: type: string nullable: true account_id: type: string nullable: true native_org_url: type: string format: uri nullable: true required: - account_id - connected - connection_id - crm_provider_name - native_org_url - self_hosted - working SingleCustomerValue: type: object properties: customer: $ref: '#/components/schemas/LightweightCustomer' value: type: string format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,10})?$ required: - customer - value SingleDayCostAnalysis: type: object properties: date: type: string format: date cost_data: type: array items: $ref: '#/components/schemas/SingleMetricCost' revenue: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - cost_data - date - revenue SingleKPI: type: object properties: kpi: enum: - total_revenue - average_revenue - new_revenue - total_cost - profit - churn type: string description: |- * `total_revenue` - Total Revenue * `average_revenue` - Average Revenue * `new_revenue` - New Revenue * `total_cost` - Total Cost * `profit` - Profit * `churn` - Churn value: type: string format: decimal pattern: ^-?\d{0,10}(?:\.\d{0,10})?$ required: - kpi - value SingleMetricCost: type: object properties: metric: $ref: '#/components/schemas/MetricDetail' cost: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - cost - metric SinglePaymentProcesor: type: object properties: payment_provider_name: type: string connected: type: boolean redirect_url: type: string format: uri self_hosted: type: boolean connection_id: type: string nullable: true working: type: boolean account_id: type: string nullable: true required: - account_id - connected - connection_id - payment_provider_name - redirect_url - self_hosted - working SinglePlanAnalysis: type: object properties: plan: $ref: '#/components/schemas/LightweightPlanVersion' kpis: type: array items: $ref: '#/components/schemas/SingleKPI' required: - kpis - plan SinglePlanNumCustomers: type: object properties: plan_name: type: string num_customers: type: integer percent_total: type: number format: double required: - num_customers - percent_total - plan_name SingleSubstitution: type: object properties: substitution_name: type: string original_plan: $ref: '#/components/schemas/PlanRepresentation' new_plan: $ref: '#/components/schemas/PlanRepresentation' pct_revenue_change: type: number format: double nullable: true results: $ref: '#/components/schemas/SingleSubstitutionResults' required: - new_plan - original_plan - pct_revenue_change - results - substitution_name SingleSubstitutionResults: type: object properties: cumulative_revenue: type: array items: $ref: '#/components/schemas/RevenueDate' revenue_by_metric: type: array items: $ref: '#/components/schemas/MetricRevenue' top_customers: $ref: '#/components/schemas/TopCustomers' required: - cumulative_revenue - revenue_by_metric - top_customers StoreTokenRequestRequest: type: object properties: publicToken: type: string minLength: 1 description: The public token obtained from the Vessel API required: - publicToken StoreTokenResponse: type: object properties: success: type: boolean description: Whether the token was successfully stored required: - success StripeCancelSubscriptionsFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status StripeCancelSubscriptionsSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status StripeMultiSubscriptionsRequest: type: object properties: customer_id: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend stripe_subscription_ids: type: array items: type: string minLength: 1 required: - customer_id - stripe_subscription_ids StripeSubscriptionRecord: type: object properties: fully_billed: type: boolean readOnly: true subscription_id: type: string metadata: type: object additionalProperties: {} subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' addons: type: array items: $ref: '#/components/schemas/LightweightAddOnSubscriptionRecord' stripe_subscription_id: type: string readOnly: true nullable: true is_new: type: boolean description: Whether this subscription came from a renewal or from a first-time. Defaults to true on creation. customer: $ref: '#/components/schemas/LightweightCustomer' billing_plan: $ref: '#/components/schemas/LightweightPlanVersion' start_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. required: - addons - billing_plan - customer - end_date - fully_billed - start_date - stripe_subscription_id - subscription_filters - subscription_id StripeTurnOffAutoRenewalFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status StripeTurnOffAutoRenewalSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status SubscriptionCancelledRequest: type: object properties: payload: $ref: '#/components/schemas/SubscriptionRecordRequest' required: - payload SubscriptionCreatedRequest: type: object properties: payload: $ref: '#/components/schemas/SubscriptionRecordRequest' required: - payload SubscriptionCustomerSummary: type: object properties: billing_plan_name: type: string plan_version: type: integer end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. required: - billing_plan_name - end_date - plan_version SubscriptionFilter: type: object properties: value: type: string property_name: type: string description: "The string name of the property to filter on. Example: 'product_id'" required: - property_name - value SubscriptionFilterRequest: type: object properties: value: type: string minLength: 1 property_name: type: string minLength: 1 description: "The string name of the property to filter on. Example: 'product_id'" required: - property_name - value SubscriptionRecord: type: object properties: subscription_id: type: string start_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. is_new: type: boolean description: Whether this subscription came from a renewal or from a first-time. Defaults to true on creation. subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilter' customer: $ref: '#/components/schemas/LightweightCustomer' billing_plan: $ref: '#/components/schemas/LightweightPlanVersion' fully_billed: type: boolean readOnly: true addons: type: array items: $ref: '#/components/schemas/LightweightAddOnSubscriptionRecord' metadata: type: object additionalProperties: {} required: - addons - auto_renew - billing_plan - customer - end_date - fully_billed - is_new - metadata - start_date - subscription_filters - subscription_id SubscriptionRecordCancelRequest: type: object properties: flat_fee_behavior: enum: - refund - charge_prorated - charge_full - type: string nullable: true description: |- When canceling a subscription, the behavior used to calculate the flat fee. If null or not provided, the charge's default behavior will be used according to the subscription's start and end dates. If charge_full, the full flat fee will be charged, regardless of the duration of the subscription. If refund, the flat fee will not be charged. If charge_prorated, the prorated flat fee will be charged. * `refund` - Refund * `charge_prorated` - Prorate * `charge_full` - Charge Full usage_behavior: enum: - bill_full - bill_none type: string default: bill_full description: |- If bill_full, current usage will be billed on the invoice. If bill_none, current unbilled usage will be dropped from the invoice. Defaults to bill_full. * `bill_full` - Bill Full * `bill_none` - Bill None invoicing_behavior: enum: - add_to_next_invoice - invoice_now type: string default: invoice_now description: |- Whether to invoice now or invoice at the end of the billing period. Defaults to invoice now. * `add_to_next_invoice` - Add to Next Invoice * `invoice_now` - Invoice Now SubscriptionRecordCreateRequest: type: object properties: start_date: type: string format: date-time description: The date the subscription starts. This should be a string in YYYY-MM-DD format of the date in UTC time. end_date: type: string format: date-time description: The date the subscription ends. This should be a string in YYYY-MM-DD format of the date in UTC time. If you don’t set it (recommended), we will use the information in the billing plan to automatically calculate this. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. is_new: type: boolean subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: Add filter key, value pairs that define which events will be applied to this plan subscription. customer_id: type: string nullable: true minLength: 1 description: The id provided when creating the customer writeOnly: true plan_id: type: string format: uuid writeOnly: true nullable: true description: The Lotus plan_id, found in the billing plan object. We will make a best-effort attempt to find the correct plan version (matching preferred currencies, prioritizing custom plans), but if more than one plan version or no plan version matches these criteria this will return an error. component_fixed_charges_initial_units: type: array items: $ref: '#/components/schemas/ComponentsFixedChargeInitialValueRequest' description: The initial units for the plan components' prepaid fixed charges. This is only required if the plan has plan components where you did not specify the initial units. metadata: type: object additionalProperties: {} description: A JSON object containing additional information about the subscription. required: - customer_id - start_date SubscriptionRecordCreateSerializerOldRequest: type: object properties: start_date: type: string format: date-time description: The date the subscription starts. This should be a string in YYYY-MM-DD format of the date in UTC time. end_date: type: string format: date-time description: The date the subscription ends. This should be a string in YYYY-MM-DD format of the date in UTC time. If you don’t set it (recommended), we will use the information in the billing plan to automatically calculate this. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. is_new: type: boolean subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' description: Add filter key, value pairs that define which events will be applied to this plan subscription. customer_id: type: string nullable: true minLength: 1 description: The id provided when creating the customer writeOnly: true plan_id: type: string format: uuid writeOnly: true description: The Lotus plan_id, found in the billing plan object. This field has been deprecated in favor of version_id for the sake of being explicit. If used, a best effort will be made to find the correct plan version (matching preferred currencies, prioritizing custom plans), but if more than one plan versions matches this criteria this will return an error. required: - customer_id - start_date SubscriptionRecordRequest: type: object properties: subscription_id: type: string minLength: 1 start_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. end_date: type: string format: date-time description: The time the subscription starts. This will be a string in yyyy-mm-dd HH:mm:ss format in UTC time. auto_renew: type: boolean description: Whether the subscription automatically renews. Defaults to true. is_new: type: boolean description: Whether this subscription came from a renewal or from a first-time. Defaults to true on creation. subscription_filters: type: array items: $ref: '#/components/schemas/SubscriptionFilterRequest' billing_plan: $ref: '#/components/schemas/LightweightPlanVersionRequest' addons: type: array items: $ref: '#/components/schemas/LightweightAddOnSubscriptionRecordRequest' metadata: type: object additionalProperties: {} required: - addons - auto_renew - billing_plan - end_date - is_new - metadata - start_date - subscription_filters - subscription_id SubscriptionRecordSwitchPlanRequest: type: object properties: switch_plan_id: type: string format: uuid writeOnly: true description: The new plan to switch to. invoicing_behavior: enum: - add_to_next_invoice - invoice_now type: string default: invoice_now description: |- The invoicing behavior to use when replacing the plan. Invoice now will invoice the customer for the prorated difference of the old plan and the new plan, whereas add_to_next_invoice will wait until the end of the subscription to do the calculation. * `add_to_next_invoice` - Add to Next Invoice * `invoice_now` - Invoice Now usage_behavior: enum: - transfer_to_new_subscription - keep_separate type: string default: transfer_to_new_subscription description: |- The usage behavior to use when replacing the plan. Transfer to new subscription will transfer the usage from the old subscription to the new subscription, whereas keep_separate will reset the usage to 0 for the new subscription, while keeping the old usage on the old subscription and charging for that appropriately at the end of the month. * `transfer_to_new_subscription` - Transfer to New Subscription * `keep_separate` - Keep Separate component_fixed_charges_initial_units: type: array items: $ref: '#/components/schemas/ComponentsFixedChargeInitialValueRequest' description: The initial units for the plan components' prepaid fixed charges. In the context of swithciong plans, this is only required if the new plan has a component the old plan did not have, that has a prepaid charge, that deos not have a default. SubscriptionRecordUpdateRequest: type: object properties: turn_off_auto_renew: type: boolean description: Turn off auto renew for the subscription end_date: type: string format: date-time description: Change the end date for the subscription. metadata: type: object additionalProperties: {} description: Update the metadata for the subscription. SubscriptionRecordUpdateSerializerOldRequest: type: object properties: replace_plan_id: type: string format: uuid writeOnly: true description: '[DEPRECATED] Will currently perform a best-effort attempt to find the correct plan version to replace the current plan with. If more than one plan version matches the criteria, this will return an error. Use the change_plan method of a subscription instance instead.' invoicing_behavior: enum: - add_to_next_invoice - invoice_now type: string default: invoice_now description: |- The invoicing behavior to use when replacing the plan. Invoice now will invoice the customer for the prorated difference of the old plan and the new plan, whereas add_to_next_invoice will wait until the end of the subscription to do the calculation. * `add_to_next_invoice` - Add to Next Invoice * `invoice_now` - Invoice Now usage_behavior: enum: - transfer_to_new_subscription - keep_separate type: string default: transfer_to_new_subscription description: |- The usage behavior to use when replacing the plan. Transfer to new subscription will transfer the usage from the old subscription to the new subscription, whereas keep_separate will reset the usage to 0 for the new subscription, while keeping the old usage on the old subscription and charging for that appropriately at the end of the month. * `transfer_to_new_subscription` - Transfer to New Subscription * `keep_separate` - Keep Separate turn_off_auto_renew: type: boolean description: Turn off auto renew for the subscription end_date: type: string format: date-time description: Change the end date for the subscription. SubscriptionRenewedRequest: type: object properties: payload: $ref: '#/components/schemas/SubscriptionRecordRequest' required: - payload SuccessResponse: type: object properties: success: type: boolean required: - success Tag: type: object properties: tag_name: type: string maxLength: 50 tag_hex: type: string maxLength: 7 tag_color: type: string maxLength: 20 required: - tag_color - tag_hex - tag_name TagRequest: type: object properties: tag_name: type: string minLength: 1 maxLength: 50 tag_hex: type: string minLength: 1 maxLength: 7 tag_color: type: string minLength: 1 maxLength: 20 required: - tag_color - tag_hex - tag_name TargetCustomersRequest: type: object properties: customer_ids: type: array items: type: string nullable: true minLength: 1 description: The id provided when creating the customer, we suggest matching with your internal customer id in your backend required: - customer_ids TimezonesResponse: type: object properties: timezones: type: array items: type: string required: - timezones TopCustomers: type: object properties: original_plan_revenue: type: array items: $ref: '#/components/schemas/SingleCustomerValue' new_plan_revenue: type: array items: $ref: '#/components/schemas/SingleCustomerValue' biggest_pct_increase: type: array items: $ref: '#/components/schemas/SingleCustomerValue' biggest_pct_decrease: type: array items: $ref: '#/components/schemas/SingleCustomerValue' required: - biggest_pct_decrease - biggest_pct_increase - new_plan_revenue - original_plan_revenue TopCustomersPerPlanAnalysis: type: object properties: top_customers_by_revenue: type: array items: $ref: '#/components/schemas/SingleCustomerValue' maxItems: 10 top_customers_by_average_revenue: type: array items: $ref: '#/components/schemas/SingleCustomerValue' maxItems: 10 plan: $ref: '#/components/schemas/LightweightPlanVersion' required: - plan - top_customers_by_average_revenue - top_customers_by_revenue TransferSubscriptionsFailure: type: object properties: status: enum: - error type: string description: '* `error` - error' detail: type: string required: - detail - status TransferSubscriptionsRequestRequest: type: object properties: source: enum: - stripe - braintree type: string description: |- * `stripe` - Stripe * `braintree` - Braintree end_now: type: boolean required: - end_now - source TransferSubscriptionsSuccess: type: object properties: status: enum: - success type: string description: '* `success` - success' detail: type: string required: - detail - status URLResponse: type: object properties: url: type: string format: uri exists: type: boolean required: - exists - url UpdateCRMSourceOfTruthRequest: type: object properties: crm_provider_name: enum: - salesforce type: string description: '* `salesforce` - salesforce' lotus_is_source: type: boolean required: - crm_provider_name - lotus_is_source UsageAlert: type: object properties: usage_alert_id: type: string readOnly: true metric: $ref: '#/components/schemas/Metric' plan_version: $ref: '#/components/schemas/LightweightPlanVersion' threshold: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - metric - plan_version - threshold - usage_alert_id UsageAlertCreate: type: object properties: metric_id: type: string format: uuid plan_version_id: type: string format: uuid threshold: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - metric_id - plan_version_id - threshold UsageAlertCreateRequest: type: object properties: metric_id: type: string format: uuid plan_version_id: type: string format: uuid threshold: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - metric_id - plan_version_id - threshold UsageAlertPayloadRequest: type: object properties: subscription: $ref: '#/components/schemas/LightweightSubscriptionRecordRequest' usage_alert: $ref: '#/components/schemas/UsageAlertRequest' usage: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true time_triggered: type: string format: date-time required: - subscription - time_triggered - usage - usage_alert UsageAlertRequest: type: object properties: metric: $ref: '#/components/schemas/MetricRequest' plan_version: $ref: '#/components/schemas/LightweightPlanVersionRequest' threshold: type: number format: double maximum: 10000000000 minimum: -10000000000 exclusiveMaximum: true exclusiveMinimum: true required: - metric - plan_version - threshold UsageAlertTriggeredRequest: type: object properties: payload: $ref: '#/components/schemas/UsageAlertPayloadRequest' required: - payload User: type: object properties: username: type: string description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email maxLength: 254 organization_name: type: string organization_id: type: string required: - email - organization_id - organization_name - username UserRequest: type: object properties: username: type: string minLength: 1 description: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. pattern: ^[\w.@+-]+$ maxLength: 150 email: type: string format: email minLength: 1 maxLength: 254 organization_name: type: string minLength: 1 organization_id: type: string minLength: 1 required: - email - organization_id - organization_name - username WebhookEndpoint: type: object properties: webhook_endpoint_id: type: string readOnly: true name: type: string nullable: true maxLength: 100 webhook_url: type: string maxLength: 100 webhook_secret: type: string readOnly: true triggers: type: array items: $ref: '#/components/schemas/WebhookTrigger' readOnly: true required: - triggers - webhook_endpoint_id - webhook_secret - webhook_url WebhookEndpointRequest: type: object properties: name: type: string nullable: true maxLength: 100 webhook_url: type: string minLength: 1 maxLength: 100 triggers_in: type: array items: enum: - customer.created - invoice.created - invoice.paid - invoice.past_due - subscription.created - usage_alert.triggered - subscription.cancelled - subscription.renewed type: string description: |- * `customer.created` - customer.created * `invoice.created` - invoice.created * `invoice.paid` - invoice.paid * `invoice.past_due` - invoice.past_due * `subscription.created` - subscription.created * `usage_alert.triggered` - usage_alert.triggered * `subscription.cancelled` - subscription.cancelled * `subscription.renewed` - subscription.renewed writeOnly: true required: - triggers_in - webhook_url WebhookTrigger: type: object properties: trigger_name: enum: - customer.created - invoice.created - invoice.paid - invoice.past_due - subscription.created - usage_alert.triggered - subscription.cancelled - subscription.renewed type: string description: |- * `customer.created` - customer.created * `invoice.created` - invoice.created * `invoice.paid` - invoice.paid * `invoice.past_due` - invoice.past_due * `subscription.created` - subscription.created * `usage_alert.triggered` - usage_alert.triggered * `subscription.cancelled` - subscription.cancelled * `subscription.renewed` - subscription.renewed required: - trigger_name WebhookTriggerRequest: type: object properties: trigger_name: enum: - customer.created - invoice.created - invoice.paid - invoice.past_due - subscription.created - usage_alert.triggered - subscription.cancelled - subscription.renewed type: string description: |- * `customer.created` - customer.created * `invoice.created` - invoice.created * `invoice.paid` - invoice.paid * `invoice.past_due` - invoice.past_due * `subscription.created` - subscription.created * `usage_alert.triggered` - usage_alert.triggered * `subscription.cancelled` - subscription.cancelled * `subscription.renewed` - subscription.renewed required: - trigger_name securitySchemes: OrganizationApiKeyAuth: type: apiKey in: header name: X-API-KEY basicAuth: type: http scheme: basic knoxTokenAuth: type: apiKey in: header name: Authorization description: Token-based authentication with required prefix "Token"