> ## 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 Order
> ### Intent
Reads the order without changing it.
### When to call it
Call this after your application has received or stored the identifier for the order.
### Access boundary
Authorize the request with a token that carries `customer_portal:read` or `customer_portal: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/customer-portal/orders/{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/customer-portal/orders/{id}:
get:
tags:
- customer_portal
- orders
- public
summary: Read Order
description: >-
### Intent
Reads the order without changing it.
### When to call it
Call this after your application has received or stored the identifier
for the order.
### Access boundary
Authorize the request with a token that carries `customer_portal:read`
or `customer_portal:write`.
### Successful result
A successful request returns `200`. The response schema below defines
the body your integration receives.
operationId: customer_portal:orders:get
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid4
description: Identifier of the order.
title: Id
description: Identifier of the order.
responses:
'200':
description: Request completed successfully
content:
application/json:
schema:
$ref: '#/components/schemas/CustomerOrder'
'404':
description: '**Response:** Order 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:
- customer_session:
- customer_portal:read
- customer_portal:write
- member_session:
- customer_portal:read
- customer_portal:write
components:
schemas:
CustomerOrder:
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.
status:
$ref: '#/components/schemas/OrderStatus'
examples:
- paid
paid:
type: boolean
title: Paid
description: Indicates whether the order has been paid for.
examples:
- true
subtotal_amount:
type: integer
title: Subtotal Amount
description: '**Subtotal Amount:** Amount in cents, before discounts and taxes.'
examples:
- 10000
discount_amount:
type: integer
title: Discount Amount
description: '**Discount Amount:** Discount amount in cents.'
examples:
- 1000
net_amount:
type: integer
title: Net Amount
description: '**Net Amount:** Amount in cents, after discounts but before taxes.'
examples:
- 9000
tax_amount:
type: integer
title: Tax Amount
description: '**Tax Amount:** Sales tax amount in cents.'
examples:
- 720
total_amount:
type: integer
title: Total Amount
description: '**Total Amount:** Amount in cents, after discounts and taxes.'
examples:
- 9720
applied_balance_amount:
type: integer
title: Applied Balance Amount
description: >-
**Applied Balance Amount:** Customer's balance amount applied to
this invoice. Can increase the total amount paid, if the customer
has a negative balance, or decrease it, if the customer has a
positive balance.Amount in cents.
examples:
- 0
due_amount:
type: integer
title: Due Amount
description: '**Due Amount:** Amount in cents that is due for this order.'
examples:
- 0
refunded_amount:
type: integer
title: Refunded Amount
description: '**Refunded Amount:** Amount refunded in cents.'
examples:
- 0
refunded_tax_amount:
type: integer
title: Refunded Tax Amount
description: '**Refunded Tax Amount:** Sales tax refunded in cents.'
examples:
- 0
currency:
type: string
title: Currency
examples:
- usd
billing_reason:
$ref: '#/components/schemas/OrderBillingReason'
billing_name:
anyOf:
- type: string
- type: 'null'
title: Billing Name
description: >-
**Billing Name:** Name of the customer that should appear on the
invoice.
billing_address:
anyOf:
- $ref: '#/components/schemas/Address'
- type: 'null'
invoice_number:
anyOf:
- type: string
- type: 'null'
title: Invoice Number
description: >-
**Invoice Number:** Invoice number associated with this order.
`null` while the order is in `draft` status; assigned at finalize.
is_invoice_generated:
type: boolean
title: Is Invoice Generated
description: Indicates whether an invoice has been generated for this order.
receipt_number:
anyOf:
- type: string
- type: 'null'
title: Receipt Number
description: >-
**Receipt Number:** Receipt number for this order. Set once the
order is paid for organizations with receipts enabled. When set, a
downloadable receipt PDF can be obtained via the receipt endpoint.
seats:
anyOf:
- type: integer
- type: 'null'
title: Seats
description: Count of seats purchased (for seat-based one-time orders).
customer_id:
type: string
format: uuid4
title: Customer Id
product_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Product Id
discount_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Discount Id
subscription_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Subscription Id
checkout_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Checkout Id
next_payment_attempt_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Next Payment Attempt At
description: >-
**Next Payment Attempt At:** When the next automatic payment retry
is scheduled. `null` if the order is not in dunning or all retries
have been exhausted.
product:
anyOf:
- $ref: '#/components/schemas/CustomerOrderProduct'
- type: 'null'
subscription:
anyOf:
- $ref: '#/components/schemas/CustomerOrderSubscription'
- type: 'null'
items:
items:
$ref: '#/components/schemas/OrderItemSchema'
type: array
title: Items
description: '**Items:** Line items composing the order.'
description:
type: string
title: Description
description: Object representing summary description of the order.
examples:
- Pro Plan
refundable_amount:
type: integer
title: Refundable Amount
description: >-
**Refundable Amount:** Amount in cents that can still be refunded
(net, before taxes). Accounts for any applied customer balance and
previous refunds.
readOnly: true
examples:
- 9000
refundable_tax_amount:
type: integer
title: Refundable Tax Amount
description: >-
**Refundable Tax Amount:** Sales tax in cents that would be refunded
if the full refundable amount is refunded.
readOnly: true
examples:
- 720
type: object
required:
- id
- created_at
- modified_at
- status
- paid
- subtotal_amount
- discount_amount
- net_amount
- tax_amount
- total_amount
- applied_balance_amount
- due_amount
- refunded_amount
- refunded_tax_amount
- currency
- billing_reason
- billing_name
- billing_address
- invoice_number
- is_invoice_generated
- receipt_number
- customer_id
- product_id
- discount_id
- subscription_id
- checkout_id
- product
- subscription
- items
- description
- refundable_amount
- refundable_tax_amount
title: CustomerOrder
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
OrderStatus:
type: string
enum:
- draft
- pending
- paid
- refunded
- partially_refunded
- void
title: OrderStatus
OrderBillingReason:
type: string
enum:
- purchase
- subscription_create
- subscription_cycle
- subscription_update
title: OrderBillingReason
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
CustomerOrderProduct:
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.
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/BenefitPublic'
type: array
title: BenefitPublic
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.
organization:
$ref: '#/components/schemas/CustomerOrganization'
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
- prices
- benefits
- medias
- organization
title: CustomerOrderProduct
CustomerOrderSubscription:
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
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
title: CustomerOrderSubscription
OrderItemSchema:
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.
label:
type: string
title: Label
description: '**Label:** Description of the line item charge.'
examples:
- Pro Plan
amount:
type: integer
title: Amount
description: '**Amount:** Amount in cents, before discounts and taxes.'
examples:
- 10000
tax_amount:
type: integer
title: Tax Amount
description: '**Tax Amount:** Sales tax amount in cents.'
examples:
- 720
proration:
type: boolean
title: Proration
description: Indicates whether this charge is due to a proration.
examples:
- false
product_price_id:
anyOf:
- type: string
format: uuid4
- type: 'null'
title: Product Price Id
description: '**Product Price Id:** Associated price ID, if any.'
type: object
required:
- created_at
- modified_at
- id
- label
- amount
- tax_amount
- proration
- product_price_id
title: OrderItemSchema
description: Object representing order line item.
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
TrialInterval:
type: string
enum:
- day
- week
- month
- year
title: TrialInterval
ProductVisibility:
type: string
enum:
- draft
- private
- public
title: Visibility
RecurringInterval:
type: string
enum:
- day
- week
- month
- year
title: RecurringInterval
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'
BenefitPublic:
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:
$ref: '#/components/schemas/BenefitType'
description: '**Type:** Type of the benefit.'
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.
type: object
required:
- id
- created_at
- modified_at
- type
- description
- selectable
- deletable
- is_deleted
- organization_id
title: BenefitPublic
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.
CustomerOrganization:
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.
name:
type: string
title: Name
description: >-
**Name:** Organization name shown in checkout, customer portal,
emails etc.
slug:
type: string
title: Slug
description: >-
**Slug:** Unique organization slug in checkout, customer portal and
credit card statements.
avatar_url:
anyOf:
- type: string
- type: 'null'
title: Avatar Url
description: >-
**Avatar Url:** Avatar URL shown in checkout, customer portal,
emails etc.
proration_behavior:
$ref: '#/components/schemas/SubscriptionProrationBehavior'
description: >-
**Proration Behavior:** Proration behavior applied when customer
updates their subscription from the portal.
allow_customer_updates:
type: boolean
title: Allow Customer Updates
description: >-
Indicates whether customers can update their subscriptions from the
customer portal.
customer_portal_settings:
$ref: '#/components/schemas/OrganizationCustomerPortalSettings'
description: >-
**Customer Portal Settings:** Settings related to the customer
portal.
organization_features:
$ref: '#/components/schemas/CustomerOrganizationFeatureSettings'
description: '**Organization Features:** Feature flags for the customer portal.'
type: object
required:
- created_at
- modified_at
- id
- name
- slug
- avatar_url
- proration_behavior
- allow_customer_updates
- customer_portal_settings
title: CustomerOrganization
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
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.
BenefitType:
type: string
enum:
- custom
- discord
- github_repository
- downloadables
- license_keys
- meter_credit
- feature_flag
- slack_shared_channel
title: BenefitType
SubscriptionProrationBehavior:
type: string
enum:
- invoice
- prorate
- next_period
- reset
title: SubscriptionProrationBehavior
OrganizationCustomerPortalSettings:
properties:
usage:
$ref: '#/components/schemas/CustomerPortalUsageSettings'
subscription:
$ref: '#/components/schemas/CustomerPortalSubscriptionSettings'
customer:
$ref: '#/components/schemas/CustomerPortalCustomerSettings'
type: object
required:
- usage
- subscription
title: OrganizationCustomerPortalSettings
CustomerOrganizationFeatureSettings:
properties:
member_model_enabled:
type: boolean
title: Member Model Enabled
description: Indicates whether the member model is enabled for this organization.
default: false
checkout_localization_enabled:
type: boolean
title: Checkout Localization Enabled
description: Indicates whether localization is enabled for this organization.
default: false
type: object
title: CustomerOrganizationFeatureSettings
description: Feature flags exposed to the customer portal.
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.
CustomerPortalUsageSettings:
properties:
show:
type: boolean
title: Show
type: object
required:
- show
title: CustomerPortalUsageSettings
CustomerPortalSubscriptionSettings:
properties:
update_seats:
type: boolean
title: Update Seats
update_plan:
type: boolean
title: Update Plan
type: object
required:
- update_seats
- update_plan
title: CustomerPortalSubscriptionSettings
CustomerPortalCustomerSettings:
properties:
allow_email_change:
type: boolean
title: Allow Email Change
type: object
title: CustomerPortalCustomerSettings
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.
MeterUnit:
type: string
enum:
- scalar
- token
- custom
title: MeterUnit
securitySchemes:
customer_session:
type: http
description: >-
**Authentication:** Customer session tokens authenticate buyers within
your organization. Generate one through the [customer session
operation](/api-reference/customer-portal/sessions/create).
scheme: bearer
member_session:
type: http
description: >-
**Authentication:** Member session tokens authenticate team members
within a customer account. Generate one through the [member session
operation](/api-reference/member-portal/sessions/create).
scheme: bearer
````