Read Checkout Link
Intent
Reads the checkout link without changing it.
When to call it
Call this after your application has received or stored the identifier for the checkout link.
Access boundary
Authorize the request with a token that carries checkout_links:read or checkout_links:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the checkout link.
Response
Request completed successfully
Checkout link data.
The stable identifier for this record.
The time Ruba created this record.
The time this record last changed.
Unit used to measure the trial period.
day, week, month, year Length of the trial measured in the selected interval.
Payment Processor: Payment processor used.
stripe Client Secret: Client secret used to access the checkout link.
Success Url: URL where the customer will be redirected after a successful payment.
If provided, a back button will be shown in the checkout to return to this URL.
Label: Optional label to distinguish links internally.
Indicates whether to allow the customer to apply discount codes. If you apply a discount through discount_id, it'll still be applied, but the customer won't be able to change it.
Indicates whether to require the customer to fill their full billing address, instead of just the country. Customers in the US will always be required to fill their full address, regardless of this setting.
Identifier of the discount to apply to the checkout. If the discount is not applicable anymore when opening the checkout link, it'll be ignored.
Seats: Seat quantity locked into this checkout link. Every linked product must support seat pricing and accept the specified quantity. Ruba ignores the value if a product's configuration no longer supports it when checkout begins.
Identifier of the organization.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"
- DiscountFixedOnceForeverDurationBase
- DiscountFixedRepeatDurationBase
- DiscountPercentageOnceForeverDurationBase
- DiscountPercentageRepeatDurationBase