> ## Documentation Index > Fetch the complete documentation index at: https://docs.getmeasure.com/llms.txt > Use this file to discover all available pages before exploring further. # Cancel Subscription > Cancel a subscription by ID with the provided cancellation options ## OpenAPI ````yaml https://api.getmeasure.com/api/v1/docs/api_spec.json post /companies/{company_id}/subscriptions/{id}/cancel openapi: 3.1.0 info: title: Measure API description: APIs to communicate with Measure version: 1.0.0 servers: - url: https://api.getmeasure.com/api/v1 security: [] paths: /companies/{company_id}/subscriptions/{id}/cancel: post: tags: - Subscriptions summary: Cancel Subscription description: Cancel a subscription by ID with the provided cancellation options operationId: Cancel_Subscription parameters: - name: company_id in: path description: 'The company ID with the prefix ''cmp_''. ' required: true schema: description: 'The company ID with the prefix ''cmp_''. ' type: string - name: id in: path description: The resource ID required: true schema: description: The resource ID type: string - name: Idempotency-Key in: header description: >- The idempotency key that will be used to ensure the request is only performed once schema: description: >- The idempotency key that will be used to ensure the request is only performed once type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/RequestCancelSubscriptionRequest' responses: '200': description: OK content: application/json: schema: $ref: '#/components/schemas/ResponseSubscriptionLiteRepresentation' deprecated: false security: - apiKey: - '' components: schemas: RequestCancelSubscriptionRequest: description: The cancellation configuration for the subscription properties: cancel_pending_invoices: description: Whether to cancel the pending invoices in the subscription type: boolean charge_remaining_balance: description: >- Whether to charge the remaining balance on the subscription. This option cannot be combined with other refund types type: - boolean custom_end_date: description: >- The date for the cancellation in RFC-3339 format when the timing is CUSTOM format: date-time type: - 'null' - string custom_refund_amount: $ref: '#/components/schemas/ModelAmount' description: The amount for the refund when the refund type is CUSTOM customer_cancel_reason: description: An optional reason provided by the customer for the cancellation type: - 'null' - string reason: description: The reason for the subscription cancellation enum: - subscription.revoked - subscription.cancelled - subscription.expired type: - 'null' - string refund_type: description: >- This is one of PRORATED, NONE, LAST_PAYMENT or CUSTOM based on whether the refund needs to be the prorated price of the subscription, no refund, the last payment from the customer for this subscription or any custom amount respectively enum: - PRORATED - NONE - LAST_PAYMENT - CUSTOM type: string send_customer_receipt: description: Whether to email the cancellation receipt to the customer type: - 'null' - boolean timing: description: >- This is one of IMMEDIATE, CUSTOM, PERIOD_END or RENEWAL based on whether the cancellation needs to happen immediately, at a custom date, at the end of the current period or at the renewal date respectively enum: - IMMEDIATE - CUSTOM - PERIOD_END - RENEWAL type: string required: - timing - refund_type - charge_remaining_balance type: object ResponseSubscriptionLiteRepresentation: properties: arr: $ref: '#/components/schemas/ModelAmount' description: The annual recurring revenue for this subscription auto_charges: description: >- Whether the subscription is set up to automatically charge the card attached to the subscription or the default payment method on the customer type: boolean auto_renews: description: Whether the subscription is set up to automatically renew type: boolean billing_anchor_date: description: >- The billing anchor date for this subscription, typically the same as the start date format: date-time type: string cancel_config: $ref: '#/components/schemas/ModelSubscriptionCancelConfig' description: Any cancel request information for this subscription cancel_date: description: >- The date this subscription was cancelled. The end date represents the date that the subscription will actually cancel format: date-time type: - 'null' - string change_config: $ref: '#/components/schemas/ModelSubscriptionChangeConfig' description: Any change request information for this subscription change_date: description: The date this subscription is due to change to a different plan format: date-time type: - 'null' - string company_id: description: The company ID of the subscription type: string computed_entitlements: description: Computed entitlements attached to this subscription items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' config_items: description: The mapping of the quantities and the product metric pricings items: $ref: '#/components/schemas/ModelSubscriptionConfigItem' type: - array - 'null' created_at: description: The date the subscription was created format: date-time type: string customer: $ref: '#/components/schemas/ResponseCustomerLiteRepresentation' description: The expanded customer details for the subscription customer_id: description: The customer to which this subscription belongs type: string end_date: description: The end date of the subscription, if there is one format: date-time type: - 'null' - string id: description: The ID of the subscription in Measure type: string invoice_additional_display_fields: description: >- Any additional invoice key-value pairs that attached to the invoices for this subscription items: $ref: '#/components/schemas/ModelInvoiceField' type: - array - 'null' invoice_due_date_from_creation: description: The number of days between the invoice date and the due date minimum: 0 type: integer metadata: additionalProperties: true description: Any additional data as key-value pairs attached to the subscription type: object minimum_spend: $ref: '#/components/schemas/ModelAmount' description: The minimum spend for this subscription per billing period mrr: $ref: '#/components/schemas/ModelAmount' description: The monthly recurring revenue for this subscription next_invoice_date: description: The date the next invoice for this subscription will be available format: date-time type: - 'null' - string override_entitlements: description: Any entitlements attached to this subscription items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' pause_config: $ref: '#/components/schemas/ModelSubscriptionPauseConfig' description: Any pause request information for this subscription pause_date: description: The date this subscription was paused for collection format: date-time type: - 'null' - string payment_method_id: description: The payment method for this subscription, if available type: - 'null' - string product_pricing_ids: description: >- The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan items: type: string type: - array - 'null' product_pricings: description: >- The list of plans that are part of this subscription along with the quantities and minimum purchased units per metric under the plan items: $ref: >- #/components/schemas/ResponseSubscriptionProductPricingRepresentation type: - array - 'null' renewal_date: description: The renewal date of the subscription, if there is one format: date-time type: - 'null' - string sales_user: $ref: '#/components/schemas/ResponseSalesUserRepresentation' description: The commissionable user if there is one present sales_user_id: description: The ID of the commissionable user if there is one present type: - 'null' - string start_date: description: The start date of the subscription format: date-time type: string status: description: >- The subscription status which can be one of active, cancelled or unpaid type: string term: $ref: '#/components/schemas/ModelTerm' description: >- The term for the subscription, broken into the intervals and the number of intervals trial: description: Whether the subscription is a trial type: boolean trial_conversion_date: description: >- The date the trial converted to an active subscription, remains null if trial does not convert format: date-time type: - 'null' - string updated_at: description: The date the subscription was last updated format: date-time type: string type: object ModelAmount: description: The amount which has value in cents and a currency properties: currency: type: string value_in_cents: format: int64 type: integer type: object ModelSubscriptionCancelConfig: properties: campaign_id: type: string campaign_step_id: type: string charge_remaining_balance: type: - 'null' - boolean custom_end_date: format: date-time type: - 'null' - string custom_refund_amount: $ref: '#/components/schemas/ModelAmount' reason: type: - 'null' - string refund_type: type: string send_customer_receipt: type: - 'null' - boolean timing: type: string type: object ModelSubscriptionChangeConfig: properties: actual_change_time: format: date-time type: - 'null' - string all_product_pricings: items: $ref: '#/components/schemas/ModelProductPricing' type: array auto_charges: type: - 'null' - boolean auto_renews: type: - 'null' - boolean bundle_pricing: $ref: '#/components/schemas/ModelBundlePricing' bundle_pricing_id: type: - 'null' - string config_items: items: $ref: '#/components/schemas/ModelSubscriptionConfigItem' type: - array - 'null' custom_change_date: format: date-time type: - 'null' - string discounts: items: $ref: '#/components/schemas/ModelDiscountParams' type: - 'null' - array metadata: additionalProperties: true type: object minimum_spend: $ref: '#/components/schemas/ModelAmount' onetime_items: items: $ref: '#/components/schemas/ModelOneTimeParams' type: - array - 'null' payment_method_id: type: - 'null' - string product_pricing_ids: items: type: string type: - array - 'null' proration_type: enum: - NEXT - IMMEDIATE - NONE type: - string - 'null' relative_term: $ref: '#/components/schemas/ModelTerm' reset_billing_anchor: type: - 'null' - boolean term: $ref: '#/components/schemas/ModelTerm' timing: enum: - IMMEDIATE - PERIOD_END - RENEWAL - CUSTOM - RELATIVE type: - string - 'null' trial: type: - 'null' - boolean trial_term: $ref: '#/components/schemas/ModelTerm' required: - timing - proration_type type: object ResponseEntitlementDataRepresentation: properties: entitlement_id: type: string id: type: string inherited_from_id: type: - 'null' - string inherited_from_type: type: - 'null' - string key: type: string name: type: string original_value: {} overridden: type: - 'null' - boolean type: type: string value: {} type: object ModelSubscriptionConfigItem: description: >- The configuration for pricing components which can be license counts or minimum usage units properties: hide_at_checkout: description: >- Whether the pricing row will be hidden at checkout, defaults to false type: - 'null' - boolean minimum_units: description: The number of minimum units for this usage-based component format: double minimum: 0 type: number num_licenses: description: The number of licenses for this license-based component format: double minimum: 0 type: number product_metric_pricing_id: description: The product metric pricing ID to which this config applies. type: - 'null' - string product_pricing_id: description: >- The product pricing ID to which this config applies. If the product pricing contains multiple components, the same config will apply to all of them type: - 'null' - string quantity_config: $ref: '#/components/schemas/ModelQuantityConfig' sort_order: description: The sort index type: - 'null' - number upsell_product_metric_pricing_id: type: - 'null' - string type: object ResponseCustomerLiteRepresentation: properties: address: $ref: '#/components/schemas/ModelAddress' description: The address of the customer arr: $ref: '#/components/schemas/ModelAmount' description: The ARR of the customer billing_emails: description: The additional emails to cc on customer's invoices items: type: string type: - array - 'null' company_id: description: The company ID of the customer type: string computed_entitlements: description: The computed entitlements for the customer items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' created_at: description: The date the customer was created format: date-time type: string customer_integration_metadata: additionalProperties: $ref: '#/components/schemas/ModelCustomerIntegrationMetadata' type: object display_name: description: The computed display name of the customer type: string email: description: The email of the customer type: string exclude_from_metrics: description: >- Whether to exclude this customer and related fields from any metrics in Measure type: boolean id: description: The ID of the customer in Measure type: string identifier: description: >- The unique identifier for the customer that ties back to your system. You can query for a customer using this identifier type: string integration_references: description: >- The integration references of this customer in third-party applications connected to Measure items: $ref: '#/components/schemas/ResponseCustomerIntegrationRefs' type: array locale: description: The locale of the customer type: string managed_externally: description: Whether this customer is managed outside of Measure type: boolean metadata: additionalProperties: true description: The metadata as key-value pairs attached to this customer type: object mrr: $ref: '#/components/schemas/ModelAmount' description: The MRR of the customer name: description: The name of the customer type: string org_name: description: >- The name of the company or the organization this customer is a part of type: string owner_id: description: >- The company user ID of person in Measure assigned to manage this customer type: - 'null' - string parent_customer_id: description: The customer ID of the parent customer assigned in Measure type: - 'null' - string phone: description: The phone number of the customer type: string status: description: The status of the customer such as ACTIVE or ARCHIVED type: string title: description: The title of the customer, such as CEO, VP type: string updated_at: description: The date the customer was last updated format: date-time type: string type: object ModelInvoiceField: properties: name: type: string value: type: string type: object ModelSubscriptionPauseConfig: properties: behavior: type: string resume_date: format: date-time type: - 'null' - string required: - behavior type: object ResponseSubscriptionProductPricingRepresentation: properties: created_at: description: The date this product pricing was created format: date-time type: string currency: description: The currency for the product pricing type: - string - 'null' external_name: description: The externally exposed name for the product pricing type: string id: description: The ID of the product pricing type: string name: description: The name of the product pricing type: string product: $ref: '#/components/schemas/ResponseProductRepresentation' description: The expanded product for the product pricing product_id: description: The ID of the product type: string product_metric_pricings: description: The metric components of the product pricing plan items: $ref: >- #/components/schemas/ResponseSubscriptionProductMetricPricingRepresentation type: - array - 'null' tags: description: Any tags on the product pricing items: type: string type: - array - 'null' type: description: The type of product pricing such as recurring or one-time type: string updated_at: description: The date this product pricing was updated format: date-time type: string type: object ResponseSalesUserRepresentation: properties: company: $ref: '#/components/schemas/ResponseCompanyRepresentation' company_id: type: string company_user: $ref: '#/components/schemas/ResponseCompanyUserRepresentation' company_user_id: type: - 'null' - string created_at: format: date-time type: string display_email: type: string display_name: type: string email: type: - 'null' - string id: type: string name: type: - 'null' - string type: type: string updated_at: format: date-time type: string type: object ModelTerm: description: >- The term which includes a frequency interval and a count for number of intervals properties: count: description: The number of times the frequency elapses exclusiveMinimum: 0 format: int64 type: integer frequency: description: The frequency at which the term repeats enum: - HOUR - DAY - WEEK - BI_MONTH - MONTH - QUARTER - BI_ANNUAL - YEAR - ONETIME type: string required: - frequency - count type: object ModelProductPricing: properties: company_id: type: string computed_entitlements: items: $ref: '#/components/schemas/ModelEntitlementData' type: - array - 'null' created_at: format: date-time type: string currency: type: - string - 'null' deleted_at: $ref: '#/components/schemas/GormDeletedAt' description: type: string external_name: type: string id: type: string import_created_at_ref: format: date-time type: - 'null' - string import_ref: type: - 'null' - string imported_from: type: - 'null' - string metadata: additionalProperties: true type: object minimum_spend: $ref: '#/components/schemas/ModelAmount' name: type: string num_subs: minimum: 0 type: integer override_entitlements: items: $ref: '#/components/schemas/ModelEntitlementData' type: - array - 'null' product_id: type: string product_metric_pricings: items: $ref: '#/components/schemas/ModelProductMetricPricing' type: - array - 'null' state: type: string type: type: string updated_at: format: date-time type: string upsell_product_pricing: $ref: '#/components/schemas/ModelProductPricing' upsell_product_pricing_id: type: - 'null' - string type: object ModelBundlePricing: properties: bundle_product_pricings: items: $ref: '#/components/schemas/ModelBundleProductPricing' type: - array - 'null' company_id: type: string created_at: format: date-time type: string currency: type: - string - 'null' default_term: $ref: '#/components/schemas/ModelTerm' deleted_at: $ref: '#/components/schemas/GormDeletedAt' description: type: string id: type: string image_url: type: string import_created_at_ref: format: date-time type: - 'null' - string import_ref: type: - 'null' - string imported_from: type: - 'null' - string is_auto_generated: type: boolean key: type: string metadata: additionalProperties: true type: object name: type: string num_subs: minimum: 0 type: integer state: type: string updated_at: format: date-time type: string type: object ModelDiscountParams: description: The details for the discount properties: amount: $ref: '#/components/schemas/ModelAmount' cap: $ref: '#/components/schemas/ModelAmount' coupon_id: type: - 'null' - string customer_id: type: - 'null' - string expiration_date: format: date-time type: - 'null' - string import_created_at_ref: format: date-time type: - 'null' - string import_ref: type: - 'null' - string imported_from: type: - 'null' - string item_pricing_id: type: - 'null' - string name: type: string onetime_billable_id: type: - 'null' - string percent: format: double maximum: 1 minimum: 0 type: number product_id: type: - 'null' - string product_pricing_id: type: - 'null' - string proposal_id: type: - 'null' - string state: enum: - ACTIVE - PENDING - REVOKED - EXPIRED - CONSUMED type: - 'null' - string subscription_id: type: - 'null' - string type: enum: - DISCOUNT_AMOUNT - DISCOUNT_PERCENT - DISCOUNT_AMOUNT_PER_UNIT type: string required: - name - type type: object ModelOneTimeParams: description: The pricing and aggregate for the one-time billable item properties: aggregate: description: The quantity of the one-time charge exclusiveMinimum: 0 format: double type: number custom_price: $ref: '#/components/schemas/ModelOneTimeCustomPrice' description: >- The custom pricing for the product. Either 'product_pricing_id' or 'custom_price' is required product_pricing_id: description: >- The product pricing for the one-time charge. Either 'product_pricing_id' or 'custom_price' is required type: - 'null' - string quantity_config: $ref: '#/components/schemas/ModelQuantityConfig' sort_order: description: The sort index type: - 'null' - number required: - aggregate type: object ModelQuantityConfig: properties: allow_custom_quantity: type: boolean max_quantity: type: integer min_quantity: type: integer type: object ModelAddress: properties: address_line_1: type: string address_line_2: type: string city: type: string country: description: 2-character country code (ISO 3166-1 alpha-2) examples: - US type: string place_id: type: - 'null' - string state: type: string zip: type: string type: object ModelCustomerIntegrationMetadata: properties: anrok: $ref: '#/components/schemas/ModelAnrokCustomerIntegrationMetadata' avalara: $ref: '#/components/schemas/ModelAvalaraCustomerIntegrationMetadata' type: object ResponseCustomerIntegrationRefs: properties: integration_icon: type: string integration_id: type: string integration_key: type: string integration_name: type: string reference_type: type: string remote_id: type: string remote_type: type: string type: object ResponseProductRepresentation: properties: company_id: description: The company ID of the product type: string created_at: description: The date the product was created format: date-time type: string description: description: The description of the product type: string entitlements: description: The entitlements that enable features for the product items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' external_name: description: The external name of the product type: string gl_code: description: The GL code for the product type: - 'null' - string id: description: The ID of the product in Measure type: string image_url: description: The url for the image of the product type: - 'null' - string import_created_at_ref: description: The date the product was created in the import source format: date-time type: - 'null' - string import_ref: description: The import reference ID for the product type: - 'null' - string imported_from: description: Where the product is imported from type: - 'null' - string metadata: additionalProperties: true description: Any additional data as key-value pairs attached to the product type: object name: description: The name of the product type: string num_subs: description: The number of subscriptions in the company with the product minimum: 0 type: integer product_pricings: description: The product prices attached to this product items: $ref: '#/components/schemas/ResponseProductPricingRepresentation' type: - array - 'null' state: description: The state of the product such as ACTIVE or ARCHIVED type: string tags: description: Any tags on the product items: type: string type: - array - 'null' updated_at: description: The date the product was last updated format: date-time type: string type: object ResponseSubscriptionProductMetricPricingRepresentation: properties: created_at: description: The date this product metric pricing was created format: date-time type: string id: description: The ID of the product metric pricing type: string item: $ref: '#/components/schemas/ResponseBillableItemRepresentation' description: The expanded billable item object item_id: description: The billable item ID type: string item_pricing: $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation' description: The expanded billable item pricing object item_pricing_id: description: The billable item pricing ID type: string metric: $ref: '#/components/schemas/ResponseBillableMetricStringRepresentation' description: The expanded billable metric object metric_id: description: The billable metric ID type: string minimum_units: description: The minimum units committed for this product metric pricing format: double type: number num_licenses: description: The number of licenses for this product metric pricing format: double type: number updated_at: description: The date this product metric pricing was updated format: date-time type: string type: object ResponseCompanyRepresentation: properties: address: $ref: '#/components/schemas/ModelAddress' computed_entitlements: additionalProperties: {} type: object created_at: format: date-time type: string customer_id: type: - 'null' - string demo: type: boolean email: type: string entitlements: items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: array id: type: string is_dev: type: boolean legal_name: type: string name: type: string override_entitlements: items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: array phone: type: string preferred_currency: type: - string - 'null' preferred_timezone: type: string slug: type: string updated_at: format: date-time type: string type: object ResponseCompanyUserRepresentation: properties: access: $ref: '#/components/schemas/ModelCompanyUserAccess' company: $ref: '#/components/schemas/ResponseCompanyRepresentation' created_at: format: date-time type: string id: type: string image_url: type: string manager_id: type: - 'null' - string pending: type: boolean role: type: string title: type: string updated_at: format: date-time type: string user: $ref: '#/components/schemas/ResponseUserRepresentation' type: object ModelEntitlementData: properties: entitlement_id: type: string id: type: string inherited_from_id: type: - 'null' - string inherited_from_type: type: - 'null' - string key: type: string original_value: {} overriden: type: - 'null' - boolean value: {} type: object GormDeletedAt: type: object ModelProductMetricPricing: properties: company_id: type: string created_at: format: date-time type: string deleted_at: $ref: '#/components/schemas/GormDeletedAt' id: type: string item_id: type: string item_pricing_id: type: string metric_id: type: string product_id: type: string product_pricing_id: type: string updated_at: format: date-time type: string type: object ModelBundleProductPricing: properties: bundle_pricing_id: type: string company_id: type: string created_at: format: date-time type: string deleted_at: $ref: '#/components/schemas/GormDeletedAt' id: type: string product_id: type: string product_pricing_id: type: string updated_at: format: date-time type: string type: object ModelOneTimeCustomPrice: properties: amount: $ref: '#/components/schemas/ModelAmount' description: The amount of quantity description: description: The description of the one-time charge type: - string - 'null' product_id: description: The product ID type: string required: - product_id - amount type: object ModelAnrokCustomerIntegrationMetadata: properties: vat_id: type: string type: object ModelAvalaraCustomerIntegrationMetadata: properties: entity_code: type: string type: object ResponseProductPricingRepresentation: properties: company_id: description: The company ID for the product pricing type: string computed_entitlements: description: The final computed features for the product pricing items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' created_at: description: The date the product pricing was created format: date-time type: string currency: description: The currency for the product pricing type: - string - 'null' description: description: The description for the product pricing type: string external_name: description: The externally exposed name for the product pricing used on invoices type: string id: description: The ID of the product pricing in Measure type: string import_created_at_ref: description: The date the product pricing was created from the import source format: date-time type: - 'null' - string import_ref: description: The import reference of the product pricing type: - 'null' - string imported_from: description: Where the product pricing was imported from type: - 'null' - string metadata: additionalProperties: true description: >- Any additional data as key-value pairs attached to the product pricing type: object minimum_spend: $ref: '#/components/schemas/ModelAmount' description: The minimum spend across the entire term of the product pricing name: description: The name of the product pricing type: string num_subs: description: The number of subscriptions in the company with the product pricing minimum: 0 type: integer override_entitlements: description: The overridden features for the product pricing items: $ref: '#/components/schemas/ResponseEntitlementDataRepresentation' type: - array - 'null' product: $ref: '#/components/schemas/ResponseProductRepresentation' description: The expanded product for the product pricing product_id: description: The product ID that the product pricing is attached to type: string product_metric_pricings: description: The metric components of the product pricing plan items: $ref: '#/components/schemas/ResponseProductMetricPricingRepresentation' type: - array - 'null' state: description: The state of the product pricing such as ACTIVE or ARCHIVED type: string tags: description: Any tags on the product pricing items: type: string type: - array - 'null' type: description: The type of product pricing such as recurring or one-time type: string updated_at: description: The date the product pricing was last updated format: date-time type: string upsell_product_pricing_id: description: The upsell product pricing ID type: - 'null' - string type: object ResponseBillableItemRepresentation: properties: company_id: description: The company ID for the billable item type: string created_at: description: The date the billable item was created format: date-time type: string description: description: Any description attached to the billable item type: string display_type: description: >- The display type of the billable item which can be one of UNITS, AMOUNT, THOUSAND_UNITS, MILLION_UNITS type: string editable: description: Whether the billable item can be further edited type: boolean external_name: description: The public name of the billable item type: string id: description: The ID of the billable item in Measure type: string name: description: The name of the billable item type: string standard: description: >- Whether this is a standard billable item in Measure or a custom billable item type: boolean type: description: >- The type of the billable item which can be one of CUSTOM_USAGE or CUSTOM_OBJ, based on usage-based item or object-based item type: string updated_at: description: The date the billable item was last updated format: date-time type: string type: object ResponseBillableItemPricingRepresentation: properties: base_price: $ref: '#/components/schemas/ModelAmount' base_units: format: double type: number charge_type: type: string company: $ref: '#/components/schemas/ResponseCompanyRepresentation' company_id: type: string created_at: format: date-time type: string credit_price: $ref: '#/components/schemas/ModelCreditPricing' custom_price: $ref: '#/components/schemas/ModelCustomPricing' description: type: string display_type: type: string editable: type: boolean external_name: type: string fixed_price: $ref: '#/components/schemas/ModelFixedPricing' frequency: type: - string gradient_price: items: $ref: '#/components/schemas/ModelGradientPricing' type: array id: type: string item: $ref: '#/components/schemas/ResponseBillableItemRepresentation' item_id: type: string metadata: additionalProperties: true type: object minimum_spend: $ref: '#/components/schemas/ModelAmount' minimum_spend_schedule: $ref: '#/components/schemas/ModelItemPricingMinimumSpendSchedule' name: type: string num_subs: minimum: 0 type: integer proration_type: type: string recognition_schedule: $ref: '#/components/schemas/ModelItemPricingRecognitionSchedule' scheduled_price: $ref: '#/components/schemas/ModelScheduledPricing' state: type: string step_price: $ref: '#/components/schemas/ModelStepPricing' term_count: format: int64 type: integer true_up_frequency: type: - string type: type: string updated_at: format: date-time type: string volume_price: items: $ref: '#/components/schemas/ModelVolumePricing' type: array type: object ResponseBillableMetricStringRepresentation: properties: company_id: type: string created_at: format: date-time type: string description: type: string external_name: type: string id: type: string item_id: type: string metering_rule: $ref: '#/components/schemas/ResponseMeteringRuleRepresentation' name: type: string standard: type: boolean type: type: string updated_at: format: date-time type: string type: object ModelCompanyUserAccess: properties: api_tokens: type: string approvals: type: string campaign: type: string commission_plans: type: string commission_reports: type: string companies: type: string credit_notes: type: string credits: type: string customer_portal: type: string customers: type: string developers: type: string disputes: type: string email_templates: type: string entitlement: type: string events: type: string expired_card: type: string files: type: string import: type: string integration_bank_accounts: type: string integration_transactions: type: string integrations: type: string invoices: type: string journal_accounts: type: string journal_entries: type: string logs: type: string objects: type: string one_time: type: string payments: type: string pricing: type: string promotions: type: string proposal: type: string reports: type: string sales_users: type: string settings: type: string subscriptions: type: string team: type: string webhooks: type: string type: object ResponseUserRepresentation: properties: companies: items: $ref: '#/components/schemas/ResponseCompanyUserAccessRepresentation' type: array created_at: format: date-time type: string email: type: string id: type: string is_super_user: type: boolean maple_employee_role: type: - 'null' - string name: type: string otp_enabled: type: boolean updated_at: format: date-time type: string verified: type: boolean type: object ResponseProductMetricPricingRepresentation: properties: company_id: type: string created_at: format: date-time type: string id: type: string item: $ref: '#/components/schemas/ResponseBillableItemRepresentation' item_id: type: string item_pricing: $ref: '#/components/schemas/ResponseBillableItemPricingRepresentation' item_pricing_id: type: string metric: $ref: '#/components/schemas/ResponseBillableMetricStringRepresentation' metric_id: type: string product: $ref: '#/components/schemas/ResponseProductRepresentation' product_id: type: string updated_at: format: date-time type: string type: object ModelCreditPricing: properties: amount: $ref: '#/components/schemas/ModelAmount' description: Amount of credit expiration_policy: description: Expiration policy for the credit enum: - END_OF_PRICING_FREQUENCY - NEVER - END_OF_TERM type: - 'null' - string item_id: description: Item ID of the credit type: - 'null' - string scoped_product_ids: description: Product IDs this credit is restricted to. Empty = unrestricted items: type: string type: array type: description: Type of credit enum: - AMOUNT - UNITS type: string units: description: Units of credit exclusiveMinimum: 0 format: double type: number required: - type type: object ModelCustomPricing: properties: max_price_per_unit: type: number min_price_per_unit: type: number preset_price_per_unit: type: number price_per_unit: type: number type: object ModelFixedPricing: properties: price_per_unit: description: Price per unit (in cents) type: number type: object ModelGradientPricing: properties: end: description: End quantity for the row minimum: 0 type: integer flat_price: description: Flat Price (in cents) type: number is_custom_tier: description: Is custom tier type: boolean price_per_unit: description: Price per unit (in cents) type: number start: description: Start quantity for the row minimum: 0 type: integer type: object ModelItemPricingMinimumSpendSchedule: properties: allow_pulling_forward: description: Allow pulling forward of minimum spend type: boolean amount_per_period: description: Amount of period per unit (in cents) items: type: string type: - 'null' - array minimum_spend_schedule_type: description: Type of minimum spend schedule type: string type: object ModelItemPricingRecognitionSchedule: properties: amount_per_period: description: Amount of period per unit (in cents) items: type: string type: - 'null' - array recognition_schedule_type: description: Type of recognition schedule enum: - IMMEDIATE - EVENLY - DAILY_EVENLY - CUSTOM - DONT_RECOGNIZE type: string type: object ModelScheduledPricing: properties: price_per_unit_per_period: description: Price per unit (in cents) items: type: string type: - array - 'null' type: object ModelStepPricing: properties: price_per_step: description: Price per step (in cents) type: number step_size: description: Step size minimum: 0 type: integer type: object ModelVolumePricing: properties: flat_price: description: Flat Price (in cents) type: number is_custom_tier: description: Is custom tier type: boolean price_per_unit: description: Price per unit (in cents) type: number total_units_end: description: End quantity for the row minimum: 0 type: integer total_units_start: description: Start quantity for the row minimum: 0 type: integer type: object ResponseMeteringRuleRepresentation: properties: aggregator: type: string group_keys: items: type: string type: - array - 'null' property: type: string rule: type: - 'null' - string type: object ResponseCompanyUserAccessRepresentation: properties: access: $ref: '#/components/schemas/ModelCompanyUserAccess' company_id: type: string company_name: type: string id: type: string image_url: type: string role: type: string type: object securitySchemes: apiKey: type: http scheme: bearer ````