> ## Documentation Index > Fetch the complete documentation index at: https://docs.getruba.com/llms.txt > Use this file to discover all available pages before exploring further. # Read Subscription > ### Intent Reads the subscription without changing it. ### When to call it Call this after your application has received or stored the identifier for the subscription. ### Access boundary Authorize the request with a token that carries `subscriptions:read` or `subscriptions:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives. export const RubaSocials = () => { if (typeof document === "undefined") { return null; } const inject = () => { const footer = document.getElementById("footer"); if (!footer || document.getElementById("ruba-socials")) { return false; } const isDark = document.querySelector("html.dark") || document.querySelector('html[class*="dark"]'); const lineColor = isDark ? "#383838" : "#e8e8ed"; const iconColor = isDark ? "#8e8e93" : "#86868b"; const markColor = isDark ? "#ffffff" : "#08080c"; const hoverColor = "#0071e3"; const div = document.createElement("div"); div.id = "ruba-socials"; div.style.cssText = `display:flex;align-items:center;gap:20px;padding-top:20px;margin-top:20px;border-top:1px solid ${lineColor};width:100%`; const logo = `Ruba`; const spacer = `
`; const ig = ``; const li = ``; const x = ``; const github = ``; div.innerHTML = logo + spacer + ig + li + x + github; footer.appendChild(div); return true; }; if (!document.documentElement.dataset.rubaSocialsObserver) { document.documentElement.dataset.rubaSocialsObserver = "true"; const observer = new MutationObserver(() => { if (!document.getElementById("ruba-socials")) { inject(); } }); observer.observe(document.body, { childList: true, subtree: true }); } setTimeout(() => { if (!inject()) { const interval = setInterval(() => { if (inject()) { clearInterval(interval); } }, 500); setTimeout(() => clearInterval(interval), 10000); } }, 300); return null; }; ## OpenAPI ````yaml get /v1/subscriptions/{id} openapi: 3.1.0 info: title: Ruba API summary: Ruba HTTP and Webhooks API description: '**Details:** Read the docs at https://docs.getruba.com/api-reference.' version: 2026-04 servers: - url: https://api.getruba.com description: '**Details:** Production environment.' x-speakeasy-server-id: production - url: https://sandbox-api.getruba.com description: '**Details:** Sandbox environment.' x-speakeasy-server-id: sandbox security: [] tags: - name: public description: >- **Details:** Endpoints shown and documented in the Ruba API documentation and available in our SDKs. - name: private description: >- **Details:** Endpoints that should appear in the schema only in development to generate our internal JS SDK. paths: /v1/subscriptions/{id}: get: tags: - subscriptions - public summary: Read Subscription description: >- ### Intent Reads the subscription without changing it. ### When to call it Call this after your application has received or stored the identifier for the subscription. ### Access boundary Authorize the request with a token that carries `subscriptions:read` or `subscriptions:write`. ### Successful result A successful request returns `200`. The response schema below defines the body your integration receives. operationId: subscriptions:get parameters: - name: id in: path required: true schema: type: string format: uuid4 description: Identifier of the subscription. title: Id description: Identifier of the subscription. responses: '200': description: Request completed successfully content: application/json: schema: $ref: '#/components/schemas/Subscription' '404': description: '**Response:** Subscription could not be found.' content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '422': description: Request validation failed content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' security: - oidc: - subscriptions:read - subscriptions:write - pat: - subscriptions:read - subscriptions:write - oat: - subscriptions:read - subscriptions:write components: schemas: Subscription: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. amount: type: integer title: Amount description: '**Amount:** Amount of the subscription.' examples: - 10000 currency: type: string title: Currency description: '**Currency:** Currency of the subscription.' examples: - usd recurring_interval: $ref: '#/components/schemas/RecurringInterval' description: '**Recurring Interval:** Interval at which the subscription recurs.' examples: - month recurring_interval_count: type: integer title: Recurring Interval Count description: >- Count of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. status: $ref: '#/components/schemas/SubscriptionStatus' description: '**Status:** Status of the subscription.' examples: - active current_period_start: type: string format: date-time title: Current Period Start description: >- **Current Period Start:** Start timestamp of the current billing period. current_period_end: type: string format: date-time title: Current Period End description: '**Current Period End:** End timestamp of the current billing period.' trial_start: anyOf: - type: string format: date-time - type: 'null' title: Trial Start description: '**Trial Start:** Start timestamp of the trial period, if any.' trial_end: anyOf: - type: string format: date-time - type: 'null' title: Trial End description: '**Trial End:** End timestamp of the trial period, if any.' cancel_at_period_end: type: boolean title: Cancel At Period End description: >- Indicates whether the subscription will be canceled at the end of the current period. canceled_at: anyOf: - type: string format: date-time - type: 'null' title: Canceled At description: >- **Canceled At:** Timestamp when the subscription was canceled. The subscription might still be active if `cancel_at_period_end` is `true`. started_at: anyOf: - type: string format: date-time - type: 'null' title: Started At description: '**Started At:** Timestamp when the subscription started.' ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: '**Ends At:** Timestamp when the subscription will end.' ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At description: '**Ended At:** Timestamp when the subscription ended.' past_due_at: anyOf: - type: string format: date-time - type: 'null' title: Past Due At description: >- **Past Due At:** Timestamp when the subscription entered `past_due` status. customer_id: type: string format: uuid4 title: Customer Id description: Unique identifier for the subscribed customer. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the subscribed product. discount_id: anyOf: - type: string format: uuid4 - type: 'null' title: Discount Id description: Unique identifier for the applied discount, if any. checkout_id: anyOf: - type: string format: uuid4 - type: 'null' title: Checkout Id seats: anyOf: - type: integer - type: 'null' title: Seats description: >- Count of seats for seat-based subscriptions. None for non-seat subscriptions. customer_cancellation_reason: anyOf: - $ref: '#/components/schemas/CustomerCancellationReason' - type: 'null' customer_cancellation_comment: anyOf: - type: string - type: 'null' title: Customer Cancellation Comment metadata: $ref: '#/components/schemas/MetadataOutputType' custom_field_data: additionalProperties: anyOf: - type: string - type: integer - type: boolean - type: string format: date-time - type: 'null' type: object title: Custom Field Data description: Map containing values collected through custom fields. customer: $ref: '#/components/schemas/SubscriptionCustomer' product: $ref: '#/components/schemas/Product' discount: anyOf: - oneOf: - $ref: '#/components/schemas/DiscountFixedOnceForeverDurationBase' - $ref: '#/components/schemas/DiscountFixedRepeatDurationBase' - $ref: >- #/components/schemas/DiscountPercentageOnceForeverDurationBase - $ref: '#/components/schemas/DiscountPercentageRepeatDurationBase' title: SubscriptionDiscount - type: 'null' title: Discount prices: items: oneOf: - $ref: '#/components/schemas/LegacyRecurringProductPrice' - $ref: '#/components/schemas/ProductPrice' type: array title: Prices description: Collection of enabled prices for the subscription. meters: items: $ref: '#/components/schemas/SubscriptionMeter' type: array title: Meters description: Collection of meters associated with the subscription. pending_update: anyOf: - $ref: '#/components/schemas/PendingSubscriptionUpdate' - type: 'null' description: >- **Pending Update:** Pending subscription update that will be applied at the beginning of the next period. If `null`, there is no pending update. type: object required: - created_at - modified_at - id - amount - currency - recurring_interval - recurring_interval_count - status - current_period_start - current_period_end - trial_start - trial_end - cancel_at_period_end - canceled_at - started_at - ends_at - ended_at - customer_id - product_id - discount_id - checkout_id - customer_cancellation_reason - customer_cancellation_comment - metadata - customer - product - discount - prices - meters - pending_update title: Subscription ResourceNotFound: properties: error: type: string const: ResourceNotFound title: Error examples: - ResourceNotFound detail: type: string title: Detail type: object required: - error - detail title: ResourceNotFound HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError RecurringInterval: type: string enum: - day - week - month - year title: RecurringInterval SubscriptionStatus: type: string enum: - incomplete - incomplete_expired - trialing - active - past_due - canceled - unpaid title: SubscriptionStatus CustomerCancellationReason: type: string enum: - customer_service - low_quality - missing_features - switched_service - too_complex - too_expensive - unused - other title: CustomerCancellationReason MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object SubscriptionCustomer: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- Unique identifier for the customer in your system. This must be unique within the organization. Once set, it can't be updated. examples: - usr_1337 email: anyOf: - type: string - type: 'null' title: Email description: >- **Email:** Email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- Indicates whether the customer email address is verified. The address is automatically verified when the customer accesses the customer portal using their email address. examples: - true type: $ref: '#/components/schemas/CustomerType' description: >- **Type:** Type of customer: 'individual' for single users, 'team' for customers with multiple members. examples: - individual name: anyOf: - type: string - type: 'null' title: Name description: Name assigned to the customer. examples: - John Doe billing_name: anyOf: - type: string - type: 'null' title: Billing Name description: >- **Billing Name:** Name that should appear on the customer's invoices. Falls back to the customer name when not explicitly set. examples: - John Doe billing_address: anyOf: - $ref: '#/components/schemas/Address' - type: 'null' tax_id: anyOf: - prefixItems: - type: string - $ref: '#/components/schemas/TaxIDFormat' type: array maxItems: 2 minItems: 2 examples: - - '911144442' - us_ein - - FR61954506077 - eu_vat - type: 'null' title: Tax Id locale: anyOf: - type: string - type: 'null' title: Locale organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 default_payment_method_id: anyOf: - type: string format: uuid4 - type: 'null' title: Default Payment Method Id description: >- Unique identifier for the customer's default payment method, if any. Use the payment methods endpoint to retrieve its details. deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: '**Deleted At:** Timestamp for when the customer was soft deleted.' avatar_url: anyOf: - type: string - type: 'null' title: Avatar Url examples: - https://www.gravatar.com/avatar/xxx?d=404 type: object required: - id - created_at - modified_at - metadata - email_verified - type - name - billing_name - billing_address - tax_id - organization_id - deleted_at - avatar_url title: SubscriptionCustomer Product: properties: id: type: string format: uuid4 title: Id description: The stable identifier for this record. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. trial_interval: anyOf: - $ref: '#/components/schemas/TrialInterval' - type: 'null' description: Unit used to measure the trial period. trial_interval_count: anyOf: - type: integer - type: 'null' title: Trial Interval Count description: Length of the trial measured in the selected interval. name: type: string title: Name description: Customer-facing name assigned to the product. description: anyOf: - type: string - type: 'null' title: Description description: Customer-facing description attached to the product. visibility: $ref: '#/components/schemas/ProductVisibility' description: Controls where customers can discover the product. recurring_interval: anyOf: - $ref: '#/components/schemas/RecurringInterval' - type: 'null' description: >- **Recurring Interval:** Recurring interval of the product. If `None`, the product is a one-time purchase. recurring_interval_count: anyOf: - type: integer - type: 'null' title: Recurring Interval Count description: >- Count of interval units of the subscription. If this is set to 1 the charge will happen every interval (e.g. every month), if set to 2 it will be every other month, and so on. None for one-time products. is_recurring: type: boolean title: Is Recurring description: Indicates whether the product is a subscription. is_archived: type: boolean title: Is Archived description: Indicates whether the product is archived and no longer available. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the product. metadata: $ref: '#/components/schemas/MetadataOutputType' prices: items: oneOf: - $ref: '#/components/schemas/LegacyRecurringProductPrice' - $ref: '#/components/schemas/ProductPrice' type: array title: Prices description: Collection of prices for this product. benefits: items: $ref: '#/components/schemas/Benefit' title: Benefit type: array title: Benefits description: Collection of benefits granted by the product. medias: items: $ref: '#/components/schemas/ProductMediaFileRead' type: array title: Medias description: Collection of medias associated to the product. attached_custom_fields: items: $ref: '#/components/schemas/AttachedCustomField' type: array title: Attached Custom Fields description: Collection of custom fields attached to the product. type: object required: - id - created_at - modified_at - trial_interval - trial_interval_count - name - description - visibility - recurring_interval - recurring_interval_count - is_recurring - is_archived - organization_id - metadata - prices - benefits - medias - attached_custom_fields title: Product description: Object representing product. DiscountFixedOnceForeverDurationBase: properties: duration: $ref: '#/components/schemas/DiscountDuration' type: $ref: '#/components/schemas/DiscountType' amount: type: integer title: Amount deprecated: true examples: - 1000 currency: type: string title: Currency deprecated: true examples: - usd amounts: additionalProperties: type: integer type: object title: Amounts description: >- **Amounts:** Map of currency to fixed amount to discount from the total. examples: - eur: 900 usd: 1000 created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- **Name:** Name of the discount. Will be displayed to the customer when the discount is applied. code: anyOf: - type: string - type: 'null' title: Code description: >- **Code:** Code customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: '**Starts At:** Timestamp after which the discount is redeemable.' ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: >- **Ends At:** Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: >- **Max Redemptions:** Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Count of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: Identifier of the organization. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations type: object required: - duration - type - amount - currency - amounts - created_at - modified_at - id - metadata - name - code - starts_at - ends_at - max_redemptions - redemptions_count - organization_id title: DiscountFixedOnceForeverDurationBase DiscountFixedRepeatDurationBase: properties: duration: $ref: '#/components/schemas/DiscountDuration' duration_in_months: type: integer title: Duration In Months type: $ref: '#/components/schemas/DiscountType' amount: type: integer title: Amount deprecated: true examples: - 1000 currency: type: string title: Currency deprecated: true examples: - usd amounts: additionalProperties: type: integer type: object title: Amounts description: >- **Amounts:** Map of currency to fixed amount to discount from the total. examples: - eur: 900 usd: 1000 created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- **Name:** Name of the discount. Will be displayed to the customer when the discount is applied. code: anyOf: - type: string - type: 'null' title: Code description: >- **Code:** Code customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: '**Starts At:** Timestamp after which the discount is redeemable.' ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: >- **Ends At:** Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: >- **Max Redemptions:** Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Count of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: Identifier of the organization. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations type: object required: - duration - duration_in_months - type - amount - currency - amounts - created_at - modified_at - id - metadata - name - code - starts_at - ends_at - max_redemptions - redemptions_count - organization_id title: DiscountFixedRepeatDurationBase DiscountPercentageOnceForeverDurationBase: properties: duration: $ref: '#/components/schemas/DiscountDuration' type: $ref: '#/components/schemas/DiscountType' basis_points: type: integer title: Basis Points description: >- **Basis Points:** Discount percentage in basis points. A basis point is 1/100th of a percent. For example, 1000 basis points equals a 10% discount. examples: - 1000 created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- **Name:** Name of the discount. Will be displayed to the customer when the discount is applied. code: anyOf: - type: string - type: 'null' title: Code description: >- **Code:** Code customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: '**Starts At:** Timestamp after which the discount is redeemable.' ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: >- **Ends At:** Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: >- **Max Redemptions:** Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Count of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: Identifier of the organization. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations type: object required: - duration - type - basis_points - created_at - modified_at - id - metadata - name - code - starts_at - ends_at - max_redemptions - redemptions_count - organization_id title: DiscountPercentageOnceForeverDurationBase DiscountPercentageRepeatDurationBase: properties: duration: $ref: '#/components/schemas/DiscountDuration' duration_in_months: type: integer title: Duration In Months type: $ref: '#/components/schemas/DiscountType' basis_points: type: integer title: Basis Points description: >- **Basis Points:** Discount percentage in basis points. A basis point is 1/100th of a percent. For example, 1000 basis points equals a 10% discount. examples: - 1000 created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- **Name:** Name of the discount. Will be displayed to the customer when the discount is applied. code: anyOf: - type: string - type: 'null' title: Code description: >- **Code:** Code customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: '**Starts At:** Timestamp after which the discount is redeemable.' ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: >- **Ends At:** Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: >- **Max Redemptions:** Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Count of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: Identifier of the organization. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations type: object required: - duration - duration_in_months - type - basis_points - created_at - modified_at - id - metadata - name - code - starts_at - ends_at - max_redemptions - redemptions_count - organization_id title: DiscountPercentageRepeatDurationBase LegacyRecurringProductPrice: oneOf: - $ref: '#/components/schemas/LegacyRecurringProductPriceFixed' - $ref: '#/components/schemas/LegacyRecurringProductPriceCustom' discriminator: propertyName: amount_type mapping: custom: $ref: '#/components/schemas/LegacyRecurringProductPriceCustom' fixed: $ref: '#/components/schemas/LegacyRecurringProductPriceFixed' ProductPrice: oneOf: - $ref: '#/components/schemas/ProductPriceFixed' - $ref: '#/components/schemas/ProductPriceCustom' - $ref: '#/components/schemas/ProductPriceSeatBased' - $ref: '#/components/schemas/ProductPriceMeteredUnit' discriminator: propertyName: amount_type mapping: custom: $ref: '#/components/schemas/ProductPriceCustom' fixed: $ref: '#/components/schemas/ProductPriceFixed' metered_unit: $ref: '#/components/schemas/ProductPriceMeteredUnit' seat_based: $ref: '#/components/schemas/ProductPriceSeatBased' SubscriptionMeter: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. consumed_units: type: number title: Consumed Units description: Count of consumed units so far in this billing period. examples: - 25 credited_units: type: integer title: Credited Units description: Count of credited units so far in this billing period. examples: - 100 amount: type: integer title: Amount description: '**Amount:** Amount due in cents so far in this billing period.' examples: - 0 meter_id: type: string format: uuid4 title: Meter Id description: Unique identifier for the meter. examples: - d498a884-e2cd-4d3e-8002-f536468a8b22 meter: $ref: '#/components/schemas/Meter' description: '**Meter:** Meter associated with this subscription.' type: object required: - created_at - modified_at - id - consumed_units - credited_units - amount - meter_id - meter title: SubscriptionMeter description: Current consumption and spending for a subscription meter. PendingSubscriptionUpdate: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. applies_at: type: string format: date-time title: Applies At description: >- **Applies At:** Date and time when the subscription update will be applied. product_id: anyOf: - type: string format: uuid4 - type: 'null' title: Product Id description: >- Identifier of the new product to apply to the subscription. If `null`, the product won't be changed. seats: anyOf: - type: integer - type: 'null' title: Seats description: >- Count of seats to apply to the subscription. If `null`, the number of seats won't be changed. type: object required: - created_at - modified_at - id - applies_at - product_id - seats title: PendingSubscriptionUpdate description: >- Pending update to be applied to a subscription at the beginning of the next period. ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: title: Input ctx: type: object title: Context type: object required: - loc - msg - type title: ValidationError CustomerType: type: string enum: - individual - team title: CustomerType Address: properties: line1: anyOf: - type: string - type: 'null' title: Line1 line2: anyOf: - type: string - type: 'null' title: Line2 postal_code: anyOf: - type: string - type: 'null' title: Postal Code city: anyOf: - type: string - type: 'null' title: City state: anyOf: - type: string - type: 'null' title: State country: type: string enum: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW title: CountryAlpha2 examples: - US - SE - FR x-speakeasy-enums: - AD - AE - AF - AG - AI - AL - AM - AO - AQ - AR - AS - AT - AU - AW - AX - AZ - BA - BB - BD - BE - BF - BG - BH - BI - BJ - BL - BM - BN - BO - BQ - BR - BS - BT - BV - BW - BY - BZ - CA - CC - CD - CF - CG - CH - CI - CK - CL - CM - CN - CO - CR - CU - CV - CW - CX - CY - CZ - DE - DJ - DK - DM - DO - DZ - EC - EE - EG - EH - ER - ES - ET - FI - FJ - FK - FM - FO - FR - GA - GB - GD - GE - GF - GG - GH - GI - GL - GM - GN - GP - GQ - GR - GS - GT - GU - GW - GY - HK - HM - HN - HR - HT - HU - ID - IE - IL - IM - IN - IO - IQ - IR - IS - IT - JE - JM - JO - JP - KE - KG - KH - KI - KM - KN - KP - KR - KW - KY - KZ - LA - LB - LC - LI - LK - LR - LS - LT - LU - LV - LY - MA - MC - MD - ME - MF - MG - MH - MK - ML - MM - MN - MO - MP - MQ - MR - MS - MT - MU - MV - MW - MX - MY - MZ - NA - NC - NE - NF - NG - NI - NL - 'NO' - NP - NR - NU - NZ - OM - PA - PE - PF - PG - PH - PK - PL - PM - PN - PR - PS - PT - PW - PY - QA - RE - RO - RS - RU - RW - SA - SB - SC - SD - SE - SG - SH - SI - SJ - SK - SL - SM - SN - SO - SR - SS - ST - SV - SX - SY - SZ - TC - TD - TF - TG - TH - TJ - TK - TL - TM - TN - TO - TR - TT - TV - TW - TZ - UA - UG - UM - US - UY - UZ - VA - VC - VE - VG - VI - VN - VU - WF - WS - YE - YT - ZA - ZM - ZW type: object required: - country title: Address TrialInterval: type: string enum: - day - week - month - year title: TrialInterval ProductVisibility: type: string enum: - draft - private - public title: Visibility Benefit: oneOf: - $ref: '#/components/schemas/BenefitCustom' - $ref: '#/components/schemas/BenefitDiscord' - $ref: '#/components/schemas/BenefitGitHubRepository' - $ref: '#/components/schemas/BenefitDownloadables' - $ref: '#/components/schemas/BenefitLicenseKeys' - $ref: '#/components/schemas/BenefitMeterCredit' - $ref: '#/components/schemas/BenefitFeatureFlag' - $ref: '#/components/schemas/BenefitSlackSharedChannel' discriminator: propertyName: type mapping: custom: $ref: '#/components/schemas/BenefitCustom' discord: $ref: '#/components/schemas/BenefitDiscord' downloadables: $ref: '#/components/schemas/BenefitDownloadables' feature_flag: $ref: '#/components/schemas/BenefitFeatureFlag' github_repository: $ref: '#/components/schemas/BenefitGitHubRepository' license_keys: $ref: '#/components/schemas/BenefitLicenseKeys' meter_credit: $ref: '#/components/schemas/BenefitMeterCredit' slack_shared_channel: $ref: '#/components/schemas/BenefitSlackSharedChannel' ProductMediaFileRead: properties: id: type: string format: uuid4 title: Id description: The stable identifier for this record. organization_id: type: string format: uuid4 title: Organization Id name: type: string title: Name path: type: string title: Path mime_type: type: string title: Mime Type size: type: integer title: Size storage_version: anyOf: - type: string - type: 'null' title: Storage Version checksum_etag: anyOf: - type: string - type: 'null' title: Checksum Etag checksum_sha256_base64: anyOf: - type: string - type: 'null' title: Checksum Sha256 Base64 checksum_sha256_hex: anyOf: - type: string - type: 'null' title: Checksum Sha256 Hex last_modified_at: anyOf: - type: string format: date-time - type: 'null' title: Last Modified At version: anyOf: - type: string - type: 'null' title: Version service: type: string const: product_media title: Service is_uploaded: type: boolean title: Is Uploaded created_at: type: string format: date-time title: Created At size_readable: type: string title: Size Readable readOnly: true public_url: type: string title: Public Url readOnly: true type: object required: - id - organization_id - name - path - mime_type - size - storage_version - checksum_etag - checksum_sha256_base64 - checksum_sha256_hex - last_modified_at - version - service - is_uploaded - created_at - size_readable - public_url title: ProductMediaFileRead description: File to be used as a product media file. AttachedCustomField: properties: custom_field_id: type: string format: uuid4 title: Custom Field Id description: Identifier of the custom field. custom_field: $ref: '#/components/schemas/CustomField' title: CustomField order: type: integer title: Order description: '**Order:** Order of the custom field in the resource.' required: type: boolean title: Required description: Indicates whether the value is required for this custom field. type: object required: - custom_field_id - custom_field - order - required title: AttachedCustomField description: Schema of a custom field attached to a resource. DiscountDuration: type: string enum: - once - forever - repeating title: DiscountDuration DiscountType: type: string enum: - fixed - percentage title: DiscountType LegacyRecurringProductPriceFixed: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: fixed title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. type: type: string const: recurring title: Type description: '**Type:** Type of the price.' recurring_interval: $ref: '#/components/schemas/RecurringInterval' description: '**Recurring Interval:** Recurring interval of the price.' price_amount: type: integer title: Price Amount description: '**Price Amount:** Price in cents.' legacy: type: boolean const: true title: Legacy readOnly: true type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - type - recurring_interval - price_amount - legacy title: LegacyRecurringProductPriceFixed description: >- A recurring price for a product, i.e. a subscription. **Deprecated**: The recurring interval should be set on the product itself. LegacyRecurringProductPriceCustom: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: custom title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. type: type: string const: recurring title: Type description: '**Type:** Type of the price.' recurring_interval: $ref: '#/components/schemas/RecurringInterval' description: '**Recurring Interval:** Recurring interval of the price.' minimum_amount: type: integer title: Minimum Amount description: >- **Minimum Amount:** Minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. maximum_amount: anyOf: - type: integer - type: 'null' title: Maximum Amount description: '**Maximum Amount:** Maximum amount the customer can pay.' preset_amount: anyOf: - type: integer - type: 'null' title: Preset Amount description: '**Preset Amount:** Initial amount shown to the customer.' legacy: type: boolean const: true title: Legacy readOnly: true type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - type - recurring_interval - minimum_amount - maximum_amount - preset_amount - legacy title: LegacyRecurringProductPriceCustom description: >- A pay-what-you-want recurring price for a product, i.e. a subscription. **Deprecated**: The recurring interval should be set on the product itself. ProductPriceFixed: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: fixed title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. price_amount: type: integer title: Price Amount description: '**Price Amount:** Price in cents.' type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - price_amount title: ProductPriceFixed description: Object representing fixed price for a product. ProductPriceCustom: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: custom title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. minimum_amount: type: integer title: Minimum Amount description: >- **Minimum Amount:** Minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. maximum_amount: anyOf: - type: integer - type: 'null' title: Maximum Amount description: '**Maximum Amount:** Maximum amount the customer can pay.' preset_amount: anyOf: - type: integer - type: 'null' title: Preset Amount description: '**Preset Amount:** Initial amount shown to the customer.' type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - minimum_amount - maximum_amount - preset_amount title: ProductPriceCustom description: Object representing pay-what-you-want price for a product. ProductPriceSeatBased: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: seat_based title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. seat_tiers: $ref: '#/components/schemas/ProductPriceSeatTiers-Output' description: '**Seat Tiers:** Tiered pricing based on seat quantity.' type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - seat_tiers title: ProductPriceSeatBased description: Object representing seat-based price for a product. ProductPriceMeteredUnit: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: Unique identifier for the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- **Source:** Source of the price . `catalog` is a predefined price, while `ad_hoc` is a price created dynamically on a Checkout session. amount_type: type: string const: metered_unit title: Amount Type price_currency: type: string title: Price Currency description: '**Price Currency:** Currency in which the customer will be charged.' tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- **Tax Behavior:** Tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Indicates whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: Unique identifier for the product owning the price. unit_amount: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Unit Amount description: '**Unit Amount:** Price per unit in cents.' cap_amount: anyOf: - type: integer - type: 'null' title: Cap Amount description: >- **Cap Amount:** Maximum amount in cents that can be charged, regardless of the number of units consumed. meter_id: type: string format: uuid4 title: Meter Id description: Unique identifier for the meter associated to the price. meter: $ref: '#/components/schemas/ProductPriceMeter' description: '**Meter:** Meter associated to the price.' type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - unit_amount - cap_amount - meter_id - meter title: ProductPriceMeteredUnit description: >- Object representing metered, usage-based, price for a product, with a fixed unit price. Meter: properties: metadata: $ref: '#/components/schemas/MetadataOutputType' created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. name: type: string title: Name description: >- Name assigned to the meter. Will be shown on customer's invoices and usage. unit: $ref: '#/components/schemas/MeterUnit' description: '**Unit:** Unit of the meter.' custom_label: anyOf: - type: string - type: 'null' title: Custom Label description: '**Custom Label:** Label for the custom unit.' custom_multiplier: anyOf: - type: integer - type: 'null' title: Custom Multiplier description: >- **Custom Multiplier:** Multiplier to convert from base unit to display scale. filter: $ref: '#/components/schemas/Filter' description: >- **Filter:** Filter to apply on events that'll be used to calculate the meter. aggregation: oneOf: - $ref: '#/components/schemas/CountAggregation' - $ref: '#/components/schemas/PropertyAggregation' - $ref: '#/components/schemas/UniqueAggregation' title: Aggregation description: >- **Aggregation:** Aggregation to apply on the filtered events to calculate the meter. discriminator: propertyName: func mapping: avg: $ref: '#/components/schemas/PropertyAggregation' count: $ref: '#/components/schemas/CountAggregation' max: $ref: '#/components/schemas/PropertyAggregation' min: $ref: '#/components/schemas/PropertyAggregation' sum: $ref: '#/components/schemas/PropertyAggregation' unique: $ref: '#/components/schemas/UniqueAggregation' organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the meter. archived_at: anyOf: - type: string format: date-time - type: 'null' title: Archived At description: >- Indicates whether the meter is archived and the time it was archived. type: object required: - metadata - created_at - modified_at - id - name - unit - filter - aggregation - organization_id title: Meter BenefitCustom: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: custom title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitCustomProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitCustom description: |- A benefit of type `custom`. Use it to grant any kind of benefit that doesn't fit in the other types. BenefitDiscord: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: discord title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitDiscordProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitDiscord description: |- A benefit of type `discord`. Use it to automatically invite your backers to a Discord server. BenefitGitHubRepository: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: github_repository title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitGitHubRepositoryProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitGitHubRepository description: >- A benefit of type `github_repository`. Use it to automatically invite your backers to a private GitHub repository. BenefitDownloadables: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: downloadables title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitDownloadablesProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitDownloadables BenefitLicenseKeys: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: license_keys title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitLicenseKeysProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitLicenseKeys BenefitMeterCredit: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: meter_credit title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitMeterCreditProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitMeterCredit description: |- A benefit of type `meter_unit`. Use it to grant a number of units on a specific meter. BenefitFeatureFlag: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: feature_flag title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitFeatureFlagProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitFeatureFlag description: |- A benefit of type `feature_flag`. Use it to grant feature flags with key-value metadata that can be queried via the API and webhooks. BenefitSlackSharedChannel: properties: id: type: string format: uuid4 title: Id description: Unique identifier for the benefit. created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. type: type: string const: slack_shared_channel title: Type description: type: string title: Description description: Description attached to the benefit. selectable: type: boolean title: Selectable description: Indicates whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Indicates whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Indicates whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' visibility: $ref: '#/components/schemas/BenefitVisibility' description: >- **Visibility:** Controls whether customers can see this benefit in their portal. properties: $ref: '#/components/schemas/BenefitSlackSharedChannelProperties' visibility_configurable: type: boolean title: Visibility Configurable readOnly: true type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - visibility - properties - visibility_configurable title: BenefitSlackSharedChannel CustomField: oneOf: - $ref: '#/components/schemas/CustomFieldText' - $ref: '#/components/schemas/CustomFieldNumber' - $ref: '#/components/schemas/CustomFieldDate' - $ref: '#/components/schemas/CustomFieldCheckbox' - $ref: '#/components/schemas/CustomFieldSelect' discriminator: propertyName: type mapping: checkbox: $ref: '#/components/schemas/CustomFieldCheckbox' date: $ref: '#/components/schemas/CustomFieldDate' number: $ref: '#/components/schemas/CustomFieldNumber' select: $ref: '#/components/schemas/CustomFieldSelect' text: $ref: '#/components/schemas/CustomFieldText' ProductPriceSource: type: string enum: - catalog - ad_hoc title: ProductPriceSource TaxBehaviorOption: type: string enum: - location - inclusive - exclusive title: TaxBehaviorOption ProductPriceSeatTiers-Output: properties: seat_tier_type: $ref: '#/components/schemas/SeatTierType' description: >- **Seat Tier Type:** How tiers are applied. 'volume' prices all seats at the matching tier's rate. 'graduated' prices each tier's range independently. default: volume tiers: items: $ref: '#/components/schemas/ProductPriceSeatTier' type: array minItems: 1 title: Tiers description: Collection of pricing tiers. minimum_seats: type: integer title: Minimum Seats description: >- **Minimum Seats:** Minimum number of seats required for purchase, derived from first tier. readOnly: true maximum_seats: anyOf: - type: integer - type: 'null' title: Maximum Seats description: >- **Maximum Seats:** Maximum number of seats allowed for purchase, derived from last tier. None for unlimited. readOnly: true type: object required: - tiers - minimum_seats - maximum_seats title: ProductPriceSeatTiers description: |- List of pricing tiers for seat-based pricing. The minimum and maximum seat limits are derived from the tiers: - minimum_seats = first tier's min_seats - maximum_seats = last tier's max_seats (None for unlimited) ProductPriceMeter: properties: id: type: string format: uuid4 title: Id description: The stable identifier for this record. name: type: string title: Name description: Name assigned to the meter. unit: $ref: '#/components/schemas/MeterUnit' description: '**Unit:** Unit of the meter.' custom_label: anyOf: - type: string - type: 'null' title: Custom Label description: '**Custom Label:** Label for the custom unit.' custom_multiplier: anyOf: - type: integer - type: 'null' title: Custom Multiplier description: >- **Custom Multiplier:** Multiplier to convert from base unit to display scale. type: object required: - id - name - unit title: ProductPriceMeter description: Object representing meter associated to a metered price. MeterUnit: type: string enum: - scalar - token - custom title: MeterUnit Filter: properties: conjunction: $ref: '#/components/schemas/FilterConjunction' clauses: items: anyOf: - $ref: '#/components/schemas/FilterClause' - $ref: '#/components/schemas/Filter' type: array title: Clauses type: object required: - conjunction - clauses title: Filter CountAggregation: properties: func: type: string const: count title: Func default: count type: object title: CountAggregation PropertyAggregation: properties: func: type: string enum: - sum - max - min - avg title: Func property: type: string title: Property type: object required: - func - property title: PropertyAggregation UniqueAggregation: properties: func: type: string const: unique title: Func default: unique property: type: string title: Property type: object required: - property title: UniqueAggregation BenefitVisibility: type: string enum: - draft - private - public title: Visibility BenefitCustomProperties: properties: note: anyOf: - anyOf: - type: string - type: 'null' description: >- **Note:** Private note to be shared with customers who have this benefit granted. - type: 'null' title: Note type: object required: - note title: BenefitCustomProperties description: Properties for a benefit of type `custom`. BenefitDiscordProperties: properties: guild_id: type: string title: Guild Id description: Unique identifier for the Discord server. role_id: type: string title: Role Id description: Unique identifier for the Discord role to grant. kick_member: type: boolean title: Kick Member description: >- Indicates whether to kick the member from the Discord server on revocation. guild_token: type: string title: Guild Token readOnly: true type: object required: - guild_id - role_id - kick_member - guild_token title: BenefitDiscordProperties description: Properties for a benefit of type `discord`. BenefitGitHubRepositoryProperties: properties: repository_owner: type: string title: Repository Owner description: '**Repository Owner:** Owner of the repository.' examples: - Rubadot repository_name: type: string title: Repository Name description: Name assigned to the repository. examples: - private_repo permission: type: string enum: - pull - triage - push - maintain - admin title: Permission description: >- **Permission:** Repository access level granted to the customer. See [GitHub repository roles](https://docs.github.com/en/organizations/managing-user-access-to-your-organizations-repositories/managing-repository-roles/repository-roles-for-an-organization#permissions-for-each-role) for the capabilities of each role. type: object required: - repository_owner - repository_name - permission title: BenefitGitHubRepositoryProperties description: Properties for a benefit of type `github_repository`. BenefitDownloadablesProperties: properties: archived: additionalProperties: type: boolean propertyNames: format: uuid4 type: object title: Archived files: items: type: string format: uuid4 type: array title: Files type: object required: - archived - files title: BenefitDownloadablesProperties BenefitLicenseKeysProperties: properties: prefix: anyOf: - type: string - type: 'null' title: Prefix expires: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyExpirationProperties' - type: 'null' activations: anyOf: - $ref: '#/components/schemas/BenefitLicenseKeyActivationProperties' - type: 'null' limit_usage: anyOf: - type: integer - type: 'null' title: Limit Usage type: object required: - prefix - expires - activations - limit_usage title: BenefitLicenseKeysProperties BenefitMeterCreditProperties: properties: units: type: integer title: Units rollover: type: boolean title: Rollover meter_id: type: string format: uuid4 title: Meter Id type: object required: - units - rollover - meter_id title: BenefitMeterCreditProperties description: Properties for a benefit of type `meter_unit`. BenefitFeatureFlagProperties: properties: {} type: object title: BenefitFeatureFlagProperties description: Properties for a benefit of type `feature_flag`. BenefitSlackSharedChannelProperties: properties: slack_integration_id: type: string format: uuid4 title: Slack Integration Id description: >- **Slack Integration Id:** Ruba Slack integration linked to this benefit. channel_name_template: type: string maxLength: 80 minLength: 1 title: Channel Name Template description: >- **Channel Name Template:** Template for the channel name. Supports placeholders: {customer_name}, {customer_email_local}, and {metadata.} for any value stored in customer user metadata. private: type: boolean title: Private description: '**Private:** Create the channel as private (recommended).' default: true welcome_message: anyOf: - type: string maxLength: 4000 - type: 'null' title: Welcome Message description: >- **Welcome Message:** Optional message posted to the channel right after creation. archive_on_revoke: type: boolean title: Archive On Revoke description: >- **Archive On Revoke:** Archive the channel when the benefit is revoked. default: true team_invitees: items: type: string type: array title: Team Invitees description: >- **Team Invitees:** Slack user IDs from the merchant workspace to invite to every channel created for this benefit. type: object required: - slack_integration_id - channel_name_template title: BenefitSlackSharedChannelProperties CustomFieldText: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: text title: Type slug: type: string title: Slug description: '**Slug:** Storage key used for this custom field.' name: type: string title: Name description: Display name assigned to the custom field. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations properties: $ref: '#/components/schemas/CustomFieldTextProperties' type: object required: - created_at - modified_at - id - metadata - type - slug - name - organization_id - properties title: CustomFieldText description: Schema for a custom field of type text. CustomFieldNumber: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: number title: Type slug: type: string title: Slug description: '**Slug:** Storage key used for this custom field.' name: type: string title: Name description: Display name assigned to the custom field. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations properties: $ref: '#/components/schemas/CustomFieldNumberProperties' type: object required: - created_at - modified_at - id - metadata - type - slug - name - organization_id - properties title: CustomFieldNumber description: Schema for a custom field of type number. CustomFieldDate: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: date title: Type slug: type: string title: Slug description: '**Slug:** Storage key used for this custom field.' name: type: string title: Name description: Display name assigned to the custom field. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations properties: $ref: '#/components/schemas/CustomFieldDateProperties' type: object required: - created_at - modified_at - id - metadata - type - slug - name - organization_id - properties title: CustomFieldDate description: Schema for a custom field of type date. CustomFieldCheckbox: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: checkbox title: Type slug: type: string title: Slug description: '**Slug:** Storage key used for this custom field.' name: type: string title: Name description: Display name assigned to the custom field. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations properties: $ref: '#/components/schemas/CustomFieldCheckboxProperties' type: object required: - created_at - modified_at - id - metadata - type - slug - name - organization_id - properties title: CustomFieldCheckbox description: Schema for a custom field of type checkbox. CustomFieldSelect: properties: created_at: type: string format: date-time title: Created At description: The time Ruba created this record. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: The time this record last changed. id: type: string format: uuid4 title: Id description: The stable identifier for this record. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: select title: Type slug: type: string title: Slug description: '**Slug:** Storage key used for this custom field.' name: type: string title: Name description: Display name assigned to the custom field. organization_id: type: string format: uuid4 title: Organization Id description: Unique identifier for the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-ruba-selector-widget: displayProperty: name resourceName: Organization resourceRoot: /v1/organizations properties: $ref: '#/components/schemas/CustomFieldSelectProperties' type: object required: - created_at - modified_at - id - metadata - type - slug - name - organization_id - properties title: CustomFieldSelect description: Schema for a custom field of type select. SeatTierType: type: string enum: - volume - graduated title: SeatTierType ProductPriceSeatTier: properties: min_seats: type: integer minimum: 1 title: Min Seats description: '**Min Seats:** Minimum number of seats (inclusive).' max_seats: anyOf: - type: integer minimum: 1 - type: 'null' title: Max Seats description: >- **Max Seats:** Maximum number of seats (inclusive). None for unlimited. price_per_seat: type: integer minimum: 0 title: Price Per Seat description: '**Price Per Seat:** Price per seat in cents for this tier.' type: object required: - min_seats - price_per_seat title: ProductPriceSeatTier description: Object representing pricing tier for seat-based pricing. FilterConjunction: type: string enum: - and - or title: FilterConjunction FilterClause: properties: property: type: string title: Property operator: $ref: '#/components/schemas/FilterOperator' value: anyOf: - type: string maxLength: 1000 - type: integer maximum: 2147483647 minimum: -2147483648 - type: boolean title: Value type: object required: - property - operator - value title: FilterClause BenefitLicenseKeyExpirationProperties: properties: ttl: type: integer exclusiveMinimum: 0 title: Ttl timeframe: type: string enum: - year - month - day title: Timeframe type: object required: - ttl - timeframe title: BenefitLicenseKeyExpirationProperties BenefitLicenseKeyActivationProperties: properties: limit: type: integer title: Limit enable_customer_admin: type: boolean title: Enable Customer Admin type: object required: - limit - enable_customer_admin title: BenefitLicenseKeyActivationProperties CustomFieldTextProperties: properties: form_label: type: string minLength: 1 title: Form Label form_help_text: type: string minLength: 1 title: Form Help Text form_placeholder: type: string minLength: 1 title: Form Placeholder textarea: type: boolean title: Textarea min_length: type: integer maximum: 2147483647 minimum: 0 title: Min Length max_length: type: integer maximum: 2147483647 minimum: 0 title: Max Length type: object title: CustomFieldTextProperties CustomFieldNumberProperties: properties: form_label: type: string minLength: 1 title: Form Label form_help_text: type: string minLength: 1 title: Form Help Text form_placeholder: type: string minLength: 1 title: Form Placeholder ge: type: integer maximum: 2147483647 minimum: -2147483648 title: Ge le: type: integer maximum: 2147483647 minimum: -2147483648 title: Le type: object title: CustomFieldNumberProperties CustomFieldDateProperties: properties: form_label: type: string minLength: 1 title: Form Label form_help_text: type: string minLength: 1 title: Form Help Text form_placeholder: type: string minLength: 1 title: Form Placeholder ge: type: integer maximum: 2147483647 minimum: -2147483648 title: Ge le: type: integer maximum: 2147483647 minimum: -2147483648 title: Le type: object title: CustomFieldDateProperties CustomFieldCheckboxProperties: properties: form_label: type: string minLength: 1 title: Form Label form_help_text: type: string minLength: 1 title: Form Help Text form_placeholder: type: string minLength: 1 title: Form Placeholder type: object title: CustomFieldCheckboxProperties CustomFieldSelectProperties: properties: form_label: type: string minLength: 1 title: Form Label form_help_text: type: string minLength: 1 title: Form Help Text form_placeholder: type: string minLength: 1 title: Form Placeholder options: items: $ref: '#/components/schemas/CustomFieldSelectOption' type: array minItems: 1 title: Options type: object required: - options title: CustomFieldSelectProperties FilterOperator: type: string enum: - eq - ne - gt - gte - lt - lte - like - not_like title: FilterOperator CustomFieldSelectOption: properties: value: type: string minLength: 1 title: Value label: type: string minLength: 1 title: Label type: object required: - value - label title: CustomFieldSelectOption securitySchemes: oidc: type: openIdConnect openIdConnectUrl: /.well-known/openid-configuration pat: type: http description: >- **Authentication:** You can generate a **Personal Access Token** from your [settings](https://getruba.com/settings). scheme: bearer oat: type: http description: >- **Authentication:** You can generate an **Organization Access Token** from your organization's settings. scheme: bearer ````