| List benefit grants | List benefit grants across all benefits accessible to the authenticated subject. |
| Create benefit | Create a new benefit (entitlement) like license keys, file downloads, or Discord access. |
| Delete benefit | Delete a benefit. Caution: all associated grants will be revoked and users will lose access. |
| List benefit files | List the downloadable files for a benefit with their download statistics. |
| Get benefit | Get a benefit by ID. |
| List grants for benefit | List the individual grants for a benefit. It’s especially useful to check if a user has been granted a benefit. |
| List benefits | List all existing benefits. |
| Update benefit | Update an existing benefit’s configuration. |
| Create checkout link | Create a checkout link. |
| Delete checkout link | Delete a checkout link. |
| Get checkout link | Get a checkout link by ID. |
| List checkout links | List checkout links. |
| Update checkout link | Update a checkout link. |
| Get checkout session | Get a checkout session by ID. |
| List checkout sessions | List checkout sessions. |
| Create custom field | Create a custom field. |
| Delete custom field | Delete a custom field. |
| Get custom field | Get a custom field by ID. |
| List custom fields | List custom fields. |
| Update custom field | Update a custom field. |
| Get customer meter | Get a customer meter by ID. |
| List customer meters | List customer meters. |
| Assign customer seat | Assign a seat for a subscription or order. |
| Claim customer seat | Claim Seat |
| Get customer seat claim info | Get claim information for a customer seat invitation. |
| List customer seats | List seats for a subscription or order. |
| Resend customer seat invitation | Resend an invitation for a pending customer seat. |
| Revoke customer seat | Revoke a customer seat. |
| Create customer | Create a new customer record with email, name, metadata, and optional external_id for reconciliation. |
| Delete customer | Delete a customer. This action cannot be undone and will immediately: - Cancel any active subscriptions for the customer - Revoke all their benefits - Clear any external_id Use it only in the context of deleting a user within your own service. Otherwise, use more granular API endpoints to cancel a specific subscription or revoke certain benefits. Note: The customers information will nonetheless be retained for historic orders and subscriptions. Set anonymize=true to also anonymize PII for GDPR compliance. |
| Delete customer by external ID | Delete a customer by external ID. Immediately cancels any active subscriptions and revokes any active benefits. Set anonymize=true to also anonymize PII for GDPR compliance. |
| Get customer | Get a customer by ID. |
| Get customer by external ID | Get a customer by external ID. |
| Get customer state | Get a customer state by ID. The customer state includes information about the customer’s active subscriptions and benefits. It’s the ideal endpoint to use when you need to get a full overview of a customer’s status. |
| Get customer state by external ID | Get a customer state by external ID. The customer state includes information about the customer’s active subscriptions and benefits. It’s the ideal endpoint to use when you need to get a full overview of a customer’s status. |
| List customers | List customers. |
| List customer payment methods | Get saved payment methods of a customer. |
| List customer payment methods by external ID | Get saved payment methods of a customer by external ID. |
| Create customer member | Create a new member for a customer. Only B2B customers with the member management feature enabled can add members. The authenticated user or organization must have access to the customer’s organization. |
| Create customer member by external ID | Create a new member for a customer identified by its external ID. |
| Delete customer member | Delete a member of a customer. |
| Delete customer member by external ID | Delete a member by external ID for a customer identified by its external ID. |
| Get customer member | Get a member of a customer by its ID. |
| Get customer member by external ID | Get a member by external ID for a customer identified by its external ID. |
| Update customer member | Update the name, email, or role of a customer member. |
| Update customer member by external ID | Update a member by external ID for a customer identified by its external ID. |
| Update customer | Update a customer. |
| Update customer by external ID | Update a customer by external ID. |
| Create discount code | Create a new discount code for products or subscriptions. |
| Delete discount | Delete a discount. |
| Get discount | Retrieve a specific discount by ID. |
| List discount codes | List all discount codes and coupons. |
| Update discount | Update an existing discount’s settings or validity. |
| List event types | List event types with aggregated statistics. |
| Update event type | Update an event type’s label. |
| Get event | Get an event by ID. |
| List event names | List event names. |
| Delete file | Delete a file. |
| List files | List files. |
| Get license key | Get a license key. |
| Get license key activation | Get a license key activation. |
| List license keys | Get license keys connected to the given organization & filters. |
| Rotate license key | Rotate a license key. Generates a new key string for the same license key record. The previous key string immediately stops validating. Status, usage, limits, expiry, and activations are preserved. |
| Update license key | Update a license key. |
| List customer members | List members with optional customer ID filter. |
| Create meter | Create a new usage meter to track customer consumption for usage-based pricing models. |
| Get meter | Retrieve a specific meter by ID. |
| List meters | List all usage meters in your organization for tracking consumption-based billing and analytics. |
| Update meter | Update an existing meter’s configuration. |
| Get metrics | Get metrics about your orders and subscriptions. Currency values are output in cents. |
| Get metrics limits | Get the interval limits for the metrics endpoint. |
| Generate order invoice | Trigger generation of an order’s invoice. |
| Get order | Get an order by ID. |
| Get order invoice | Get an order’s invoice data. |
| List orders | List orders. |
| Get order receipt | Get a presigned URL to download an order’s receipt PDF. |
| Update order | Update an order. |
| Get organization | Get an organization by ID. |
| List organizations | List organizations. |
| Get payment | Get a payment by ID. |
| List payments | List payments. |
| Create product | Create a new product with pricing and benefits (entitlements). |
| Get product | Retrieve a specific product by ID. |
| List products | List all products in your organization. |
| Update product | Update an existing product’s details, pricing, or settings. |
| Update product benefits | Update which benefits are granted when a product is purchased. |
| Create refund | Create a refund. |
| List refunds | List refunds. |
| Get subscription details | Get a subscription by ID. |
| List subscriptions | List active subscriptions. |
| Revoke subscription | Revoke a subscription, i.e cancel immediately. |
| Update subscription | Update a subscription. |
| Create webhook endpoint | Create a webhook endpoint. |
| Delete webhook endpoint | Delete a webhook endpoint. |
| Get webhook endpoint | Get a webhook endpoint by ID. |
| List webhook deliveries | List webhook deliveries. Deliveries are all the attempts to deliver a webhook event to an endpoint. |
| List webhook endpoints | List webhook endpoints. |
| Redeliver webhook event | Schedule the re-delivery of a webhook event. |
| Reset webhook endpoint secret | Regenerate a webhook endpoint secret. |
| Update webhook endpoint | Update a webhook endpoint. |