> ## Documentation Index > Fetch the complete documentation index at: https://polar.sh/docs/llms.txt > Use this file to discover all available pages before exploring further. # Update Subscription > Update a subscription. **Scopes**: `subscriptions:write` ## OpenAPI ````yaml patch /v1/subscriptions/{id} openapi: 3.1.0 info: title: Polar API summary: Polar HTTP and Webhooks API description: Read the docs at https://polar.sh/docs/api-reference version: 0.1.0 servers: - url: https://api.polar.sh description: Production environment x-speakeasy-server-id: production - url: https://sandbox-api.polar.sh description: Sandbox environment x-speakeasy-server-id: sandbox security: - access_token: [] tags: - name: public description: >- Endpoints shown and documented in the Polar API documentation and available in our SDKs. - name: private description: >- Endpoints that should appear in the schema only in development to generate our internal JS SDK. - name: mcp description: Endpoints enabled in the MCP server. paths: /v1/subscriptions/{id}: patch: tags: - subscriptions - public - mcp summary: Update Subscription description: |- Update a subscription. **Scopes**: `subscriptions:write` operationId: subscriptions:update parameters: - name: id in: path required: true schema: type: string format: uuid4 description: The subscription ID. title: Id description: The subscription ID. requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubscriptionUpdate' responses: '200': description: Subscription updated. content: application/json: schema: $ref: '#/components/schemas/Subscription' '402': description: Payment required to apply the subscription update. content: application/json: schema: $ref: '#/components/schemas/PaymentFailed' '403': description: >- Subscription is already canceled or will be at the end of the period. content: application/json: schema: $ref: '#/components/schemas/AlreadyCanceledSubscription' '404': description: Subscription not found. content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '409': description: Subscription is pending an update. content: application/json: schema: $ref: '#/components/schemas/SubscriptionLocked' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' x-codeSamples: - lang: go label: Go (SDK) source: "package main\n\nimport(\n\t\"context\"\n\t\"os\"\n\tpolargo \"github.com/polarsource/polar-go\"\n\t\"github.com/polarsource/polar-go/models/components\"\n\t\"log\"\n)\n\nfunc main() {\n ctx := context.Background()\n\n s := polargo.New(\n polargo.WithSecurity(os.Getenv(\"POLAR_ACCESS_TOKEN\")),\n )\n\n res, err := s.Subscriptions.Update(ctx, \"\", components.CreateSubscriptionUpdateSubscriptionUpdateProduct(\n components.SubscriptionUpdateProduct{\n ProductID: \"\",\n },\n ))\n if err != nil {\n log.Fatal(err)\n }\n if res.Subscription != nil {\n switch res.Subscription.Discount.Type {\n case components.SubscriptionDiscountTypeDiscountFixedOnceForeverDurationBase:\n // res.Subscription.Discount.DiscountFixedOnceForeverDurationBase is populated\n case components.SubscriptionDiscountTypeDiscountFixedRepeatDurationBase:\n // res.Subscription.Discount.DiscountFixedRepeatDurationBase is populated\n case components.SubscriptionDiscountTypeDiscountPercentageOnceForeverDurationBase:\n // res.Subscription.Discount.DiscountPercentageOnceForeverDurationBase is populated\n case components.SubscriptionDiscountTypeDiscountPercentageRepeatDurationBase:\n // res.Subscription.Discount.DiscountPercentageRepeatDurationBase is populated\n }\n\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar from polar_sdk.utils import parse_datetime with Polar( access_token="", ) as polar: res = polar.subscriptions.update(id="", subscription_update={ "trial_end": parse_datetime("2024-12-03T14:44:14.136Z"), }) # Handle response print(res) - lang: typescript label: Typescript (SDK) source: |- import { Polar } from "@polar-sh/sdk"; const polar = new Polar({ accessToken: process.env["POLAR_ACCESS_TOKEN"] ?? "", }); async function run() { const result = await polar.subscriptions.update({ id: "", subscriptionUpdate: { productId: "", }, }); console.log(result); } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; use Polar\Models\Components; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $response = $sdk->subscriptions->update( id: '', subscriptionUpdate: new Components\SubscriptionUpdateProduct( productId: '', ) ); if ($response->subscription !== null) { // handle response } components: schemas: SubscriptionUpdate: anyOf: - $ref: '#/components/schemas/SubscriptionUpdateProduct' - $ref: '#/components/schemas/SubscriptionUpdateDiscount' - $ref: '#/components/schemas/SubscriptionUpdateTrial' - $ref: '#/components/schemas/SubscriptionUpdateSeats' - $ref: '#/components/schemas/SubscriptionUpdateBillingPeriod' - $ref: '#/components/schemas/SubscriptionCancel' - $ref: '#/components/schemas/SubscriptionRevoke' Subscription: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. amount: type: integer title: Amount description: The amount of the subscription. examples: - 10000 currency: type: string title: Currency description: The currency of the subscription. examples: - usd recurring_interval: $ref: '#/components/schemas/SubscriptionRecurringInterval' description: The interval at which the subscription recurs. examples: - month recurring_interval_count: type: integer title: Recurring Interval Count description: >- Number 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: The status of the subscription. examples: - active current_period_start: type: string format: date-time title: Current Period Start description: The start timestamp of the current billing period. current_period_end: type: string format: date-time title: Current Period End description: The end timestamp of the current billing period. trial_start: anyOf: - type: string format: date-time - type: 'null' title: Trial Start description: The start timestamp of the trial period, if any. trial_end: anyOf: - type: string format: date-time - type: 'null' title: Trial End description: The end timestamp of the trial period, if any. cancel_at_period_end: type: boolean title: Cancel At Period End description: >- 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: >- The 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: The timestamp when the subscription started. ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: The timestamp when the subscription will end. ended_at: anyOf: - type: string format: date-time - type: 'null' title: Ended At description: The timestamp when the subscription ended. customer_id: type: string format: uuid4 title: Customer Id description: The ID of the subscribed customer. product_id: type: string format: uuid4 title: Product Id description: The ID of the subscribed product. discount_id: anyOf: - type: string format: uuid4 - type: 'null' title: Discount Id description: The ID of 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: >- The number 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: Key-value object storing custom field values. 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: List of enabled prices for the subscription. meters: items: $ref: '#/components/schemas/SubscriptionMeter' type: array title: Meters description: List of meters associated with the subscription. pending_update: anyOf: - $ref: '#/components/schemas/PendingSubscriptionUpdate' - type: 'null' description: >- 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 PaymentFailed: properties: error: type: string const: PaymentFailed title: Error examples: - PaymentFailed detail: type: string title: Detail type: object required: - error - detail title: PaymentFailed AlreadyCanceledSubscription: properties: error: type: string const: AlreadyCanceledSubscription title: Error examples: - AlreadyCanceledSubscription detail: type: string title: Detail type: object required: - error - detail title: AlreadyCanceledSubscription ResourceNotFound: properties: error: type: string const: ResourceNotFound title: Error examples: - ResourceNotFound detail: type: string title: Detail type: object required: - error - detail title: ResourceNotFound SubscriptionLocked: properties: error: type: string const: SubscriptionLocked title: Error examples: - SubscriptionLocked detail: type: string title: Detail type: object required: - error - detail title: SubscriptionLocked HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError SubscriptionUpdateProduct: properties: product_id: type: string format: uuid4 title: Product Id description: Update subscription to another product. examples: - d8dd2de1-21b7-4a41-8bc3-ce909c0cfe23 proration_behavior: anyOf: - $ref: '#/components/schemas/SubscriptionProrationBehavior' - type: 'null' description: >- Determine how to handle the proration billing. If not provided, will use the default organization setting. type: object required: - product_id title: SubscriptionUpdateProduct SubscriptionUpdateDiscount: properties: discount_id: anyOf: - type: string format: uuid4 - type: 'null' title: Discount Id description: >- Update the subscription to apply a new discount. If set to `null`, the discount will be removed. The change will be applied on the next billing cycle. type: object required: - discount_id title: SubscriptionUpdateDiscount SubscriptionUpdateTrial: properties: trial_end: anyOf: - type: string format: date-time - type: string const: now title: Trial End description: >- Set or extend the trial period of the subscription. If set to `now`, the trial will end immediately. type: object required: - trial_end title: SubscriptionUpdateTrial SubscriptionUpdateSeats: properties: seats: type: integer minimum: 1 title: Seats description: Update the number of seats for this subscription. proration_behavior: anyOf: - $ref: '#/components/schemas/SubscriptionProrationBehavior' - type: 'null' description: >- Determine how to handle the proration billing. If not provided, will use the default organization setting. type: object required: - seats title: SubscriptionUpdateSeats SubscriptionUpdateBillingPeriod: properties: current_billing_period_end: type: string format: date-time title: Current Billing Period End description: >- Set a new date for the end of the current billing period. The subscription will renew on this date. The new date can be earlier or later than the current period end, as long as it's in the future. It is not possible to update the current billing period on a canceled subscription. type: object required: - current_billing_period_end title: SubscriptionUpdateBillingPeriod SubscriptionCancel: properties: customer_cancellation_reason: anyOf: - $ref: '#/components/schemas/CustomerCancellationReason' - type: 'null' description: >- Customer reason for cancellation. Helpful to monitor reasons behind churn for future improvements. Only set this in case your own service is requesting the reason from the customer. Or you know based on direct conversations, i.e support, with the customer. * `too_expensive`: Too expensive for the customer. * `missing_features`: Customer is missing certain features. * `switched_service`: Customer switched to another service. * `unused`: Customer is not using it enough. * `customer_service`: Customer is not satisfied with the customer service. * `low_quality`: Customer is unhappy with the quality. * `too_complex`: Customer considers the service too complicated. * `other`: Other reason(s). customer_cancellation_comment: anyOf: - type: string - type: 'null' title: Customer Cancellation Comment description: >- Customer feedback and why they decided to cancel. **IMPORTANT:** Do not use this to store internal notes! It's intended to be input from the customer and is therefore also available in their Polar purchases library. Only set this in case your own service is requesting the reason from the customer. Or you copy a message directly from a customer conversation, i.e support. cancel_at_period_end: type: boolean title: Cancel At Period End description: >- Cancel an active subscription once the current period ends. Or uncancel a subscription currently set to be revoked at period end. type: object required: - cancel_at_period_end title: SubscriptionCancel SubscriptionRevoke: properties: customer_cancellation_reason: anyOf: - $ref: '#/components/schemas/CustomerCancellationReason' - type: 'null' description: >- Customer reason for cancellation. Helpful to monitor reasons behind churn for future improvements. Only set this in case your own service is requesting the reason from the customer. Or you know based on direct conversations, i.e support, with the customer. * `too_expensive`: Too expensive for the customer. * `missing_features`: Customer is missing certain features. * `switched_service`: Customer switched to another service. * `unused`: Customer is not using it enough. * `customer_service`: Customer is not satisfied with the customer service. * `low_quality`: Customer is unhappy with the quality. * `too_complex`: Customer considers the service too complicated. * `other`: Other reason(s). customer_cancellation_comment: anyOf: - type: string - type: 'null' title: Customer Cancellation Comment description: >- Customer feedback and why they decided to cancel. **IMPORTANT:** Do not use this to store internal notes! It's intended to be input from the customer and is therefore also available in their Polar purchases library. Only set this in case your own service is requesting the reason from the customer. Or you copy a message directly from a customer conversation, i.e support. revoke: type: boolean const: true title: Revoke description: Cancel and revoke an active subscription immediately type: object required: - revoke title: SubscriptionRevoke SubscriptionRecurringInterval: type: string enum: - day - week - month - year title: SubscriptionRecurringInterval 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: The ID of the customer. examples: - 992fae2a-2a17-4b7a-8d9e-e287cf90131b created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' external_id: anyOf: - type: string - type: 'null' title: External Id description: >- The ID of 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: >- The email address of the customer. This must be unique within the organization. examples: - customer@example.com email_verified: type: boolean title: Email Verified description: >- 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: >- The type of customer: 'individual' for single users, 'team' for customers with multiple members. examples: - individual name: anyOf: - type: string - type: 'null' title: Name description: The name of the customer. 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: The ID of the organization owning the customer. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 deleted_at: anyOf: - type: string format: date-time - type: 'null' title: Deleted At description: Timestamp for when the customer was soft deleted. avatar_url: type: string 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_address - tax_id - organization_id - deleted_at - avatar_url title: SubscriptionCustomer Product: properties: id: type: string format: uuid4 title: Id description: The ID of the object. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. trial_interval: anyOf: - $ref: '#/components/schemas/TrialInterval' - type: 'null' description: The interval unit for the trial period. trial_interval_count: anyOf: - type: integer - type: 'null' title: Trial Interval Count description: The number of interval units for the trial period. name: type: string title: Name description: The name of the product. description: anyOf: - type: string - type: 'null' title: Description description: The description of the product. visibility: $ref: '#/components/schemas/ProductVisibility' description: The visibility of the product. recurring_interval: anyOf: - $ref: '#/components/schemas/SubscriptionRecurringInterval' - type: 'null' description: >- The 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: >- Number 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: Whether the product is a subscription. is_archived: type: boolean title: Is Archived description: Whether the product is archived and no longer available. organization_id: type: string format: uuid4 title: Organization Id description: The ID of 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: List of prices for this product. benefits: items: $ref: '#/components/schemas/Benefit' title: Benefit type: array title: Benefits description: List of benefits granted by the product. medias: items: $ref: '#/components/schemas/ProductMediaFileRead' type: array title: Medias description: List of medias associated to the product. attached_custom_fields: items: $ref: '#/components/schemas/AttachedCustomField' type: array title: Attached Custom Fields description: List 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: A 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: 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- 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 customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: Timestamp after which the discount is redeemable. ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Number of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- 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 customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: Timestamp after which the discount is redeemable. ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Number of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: >- 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- 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 customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: Timestamp after which the discount is redeemable. ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Number of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: >- 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' name: type: string title: Name description: >- 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 customers can use to apply the discount during checkout. starts_at: anyOf: - type: string format: date-time - type: 'null' title: Starts At description: Timestamp after which the discount is redeemable. ends_at: anyOf: - type: string format: date-time - type: 'null' title: Ends At description: Timestamp after which the discount is no longer redeemable. max_redemptions: anyOf: - type: integer - type: 'null' title: Max Redemptions description: Maximum number of times the discount can be redeemed. redemptions_count: type: integer title: Redemptions Count description: Number of times the discount has been redeemed. organization_id: type: string format: uuid4 title: Organization Id description: The organization ID. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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' - $ref: '#/components/schemas/LegacyRecurringProductPriceFree' discriminator: propertyName: amount_type mapping: custom: $ref: '#/components/schemas/LegacyRecurringProductPriceCustom' fixed: $ref: '#/components/schemas/LegacyRecurringProductPriceFixed' free: $ref: '#/components/schemas/LegacyRecurringProductPriceFree' ProductPrice: oneOf: - $ref: '#/components/schemas/ProductPriceFixed' - $ref: '#/components/schemas/ProductPriceCustom' - $ref: '#/components/schemas/ProductPriceFree' - $ref: '#/components/schemas/ProductPriceSeatBased' - $ref: '#/components/schemas/ProductPriceMeteredUnit' discriminator: propertyName: amount_type mapping: custom: $ref: '#/components/schemas/ProductPriceCustom' fixed: $ref: '#/components/schemas/ProductPriceFixed' free: $ref: '#/components/schemas/ProductPriceFree' 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. consumed_units: type: number title: Consumed Units description: The number of consumed units so far in this billing period. examples: - 25 credited_units: type: integer title: Credited Units description: The number of credited units so far in this billing period. examples: - 100 amount: type: integer title: Amount description: The amount due in cents so far in this billing period. examples: - 0 meter_id: type: string format: uuid4 title: Meter Id description: The ID of the meter. examples: - d498a884-e2cd-4d3e-8002-f536468a8b22 meter: $ref: '#/components/schemas/Meter' description: The 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. applies_at: type: string format: date-time title: Applies At description: The date and time when the subscription update will be applied. product_id: anyOf: - type: string format: uuid4 - type: 'null' title: Product Id description: >- ID 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: >- Number 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 SubscriptionProrationBehavior: type: string enum: - invoice - prorate - next_period - reset title: SubscriptionProrationBehavior 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: ProductVisibility 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' 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' ProductMediaFileRead: properties: id: type: string format: uuid4 title: Id description: The ID of the object. 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 public_url: type: string title: Public Url 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: ID of the custom field. custom_field: $ref: '#/components/schemas/CustomField' title: CustomField order: type: integer title: Order description: Order of the custom field in the resource. required: type: boolean title: Required description: 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. type: type: string const: recurring title: Type description: The type of the price. recurring_interval: $ref: '#/components/schemas/SubscriptionRecurringInterval' description: The recurring interval of the price. price_amount: type: integer title: Price Amount description: The price in cents. legacy: type: boolean const: true title: Legacy 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. type: type: string const: recurring title: Type description: The type of the price. recurring_interval: $ref: '#/components/schemas/SubscriptionRecurringInterval' description: The recurring interval of the price. minimum_amount: type: integer title: Minimum Amount description: >- The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. Defaults to 50 cents. maximum_amount: anyOf: - type: integer - type: 'null' title: Maximum Amount description: The maximum amount the customer can pay. preset_amount: anyOf: - type: integer - type: 'null' title: Preset Amount description: The initial amount shown to the customer. legacy: type: boolean const: true title: Legacy 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. LegacyRecurringProductPriceFree: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: free title: Amount Type price_currency: type: string title: Price Currency description: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. type: type: string const: recurring title: Type description: The type of the price. recurring_interval: $ref: '#/components/schemas/SubscriptionRecurringInterval' description: The recurring interval of the price. legacy: type: boolean const: true title: Legacy type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id - type - recurring_interval - legacy title: LegacyRecurringProductPriceFree description: >- A free 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. price_amount: type: integer title: Price Amount description: The 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: A fixed price for a product. ProductPriceCustom: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. minimum_amount: type: integer title: Minimum Amount description: >- The minimum amount the customer can pay. If 0, the price is 'free or pay what you want'. Defaults to 50 cents. maximum_amount: anyOf: - type: integer - type: 'null' title: Maximum Amount description: The maximum amount the customer can pay. preset_amount: anyOf: - type: integer - type: 'null' title: Preset Amount description: The 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: A pay-what-you-want price for a product. ProductPriceFree: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: free title: Amount Type price_currency: type: string title: Price Currency description: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. type: object required: - created_at - modified_at - id - source - amount_type - price_currency - tax_behavior - is_archived - product_id title: ProductPriceFree description: A free price for a product. ProductPriceSeatBased: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. seat_tiers: $ref: '#/components/schemas/ProductPriceSeatTiers-Output' description: 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: A seat-based price for a product. ProductPriceMeteredUnit: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the price. source: $ref: '#/components/schemas/ProductPriceSource' description: >- The 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: The currency in which the customer will be charged. tax_behavior: anyOf: - $ref: '#/components/schemas/TaxBehaviorOption' - type: 'null' description: >- The tax behavior of the price. If null, it defaults to the organization's default tax behavior. is_archived: type: boolean title: Is Archived description: Whether the price is archived and no longer available. product_id: type: string format: uuid4 title: Product Id description: The ID of the product owning the price. unit_amount: type: string pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$ title: Unit Amount description: The price per unit in cents. cap_amount: anyOf: - type: integer - type: 'null' title: Cap Amount description: >- The 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: The ID of the meter associated to the price. meter: $ref: '#/components/schemas/ProductPriceMeter' description: The 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: A 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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. name: type: string title: Name description: >- The name of the meter. Will be shown on customer's invoices and usage. unit: $ref: '#/components/schemas/MeterUnit' description: The unit of the meter. custom_label: anyOf: - type: string - type: 'null' title: Custom Label description: The label for the custom unit. custom_multiplier: anyOf: - type: integer - type: 'null' title: Custom Multiplier description: The multiplier to convert from base unit to display scale. filter: $ref: '#/components/schemas/Filter' description: >- The 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: >- The 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: The ID of the organization owning the meter. archived_at: anyOf: - type: string format: date-time - type: 'null' title: Archived At description: 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: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: custom title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitCustomProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties 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: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: discord title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitDiscordProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties 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: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: github_repository title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitGitHubRepositoryProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties 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: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: downloadables title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitDownloadablesProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitDownloadables BenefitLicenseKeys: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: license_keys title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitLicenseKeysProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties title: BenefitLicenseKeys BenefitMeterCredit: properties: id: type: string format: uuid4 title: Id description: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: meter_credit title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitMeterCreditProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties 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: The ID of the benefit. created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. type: type: string const: feature_flag title: Type description: type: string title: Description description: The description of the benefit. selectable: type: boolean title: Selectable description: Whether the benefit is selectable when creating a product. deletable: type: boolean title: Deletable description: Whether the benefit is deletable. is_deleted: type: boolean title: Is Deleted description: Whether the benefit is deleted. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the benefit. metadata: $ref: '#/components/schemas/MetadataOutputType' properties: $ref: '#/components/schemas/BenefitFeatureFlagProperties' type: object required: - id - created_at - modified_at - type - description - selectable - deletable - is_deleted - organization_id - metadata - properties 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. 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: >- 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: List of pricing tiers minimum_seats: type: integer title: Minimum Seats description: >- Minimum number of seats required for purchase, derived from first tier. maximum_seats: anyOf: - type: integer - type: 'null' title: Maximum Seats description: >- Maximum number of seats allowed for purchase, derived from last tier. None for unlimited. 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 ID of the object. name: type: string title: Name description: The name of the meter. unit: $ref: '#/components/schemas/MeterUnit' description: The unit of the meter. custom_label: anyOf: - type: string - type: 'null' title: Custom Label description: The label for the custom unit. custom_multiplier: anyOf: - type: integer - type: 'null' title: Custom Multiplier description: The multiplier to convert from base unit to display scale. type: object required: - id - name - unit title: ProductPriceMeter description: A 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 BenefitCustomProperties: properties: note: anyOf: - anyOf: - type: string - type: 'null' description: >- 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: The ID of the Discord server. role_id: type: string title: Role Id description: The ID of the Discord role to grant. kick_member: type: boolean title: Kick Member description: Whether to kick the member from the Discord server on revocation. guild_token: type: string title: Guild Token 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: The owner of the repository. examples: - polarsource repository_name: type: string title: Repository Name description: The name of the repository. examples: - private_repo permission: type: string enum: - pull - triage - push - maintain - admin title: Permission description: >- The permission level to grant. Read more about roles and their permissions on [GitHub documentation](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). 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`. CustomFieldText: properties: created_at: type: string format: date-time title: Created At description: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: text title: Type slug: type: string title: Slug description: >- Identifier of the custom field. It'll be used as key when storing the value. name: type: string title: Name description: Name of the custom field. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: number title: Type slug: type: string title: Slug description: >- Identifier of the custom field. It'll be used as key when storing the value. name: type: string title: Name description: Name of the custom field. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: date title: Type slug: type: string title: Slug description: >- Identifier of the custom field. It'll be used as key when storing the value. name: type: string title: Name description: Name of the custom field. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: checkbox title: Type slug: type: string title: Slug description: >- Identifier of the custom field. It'll be used as key when storing the value. name: type: string title: Name description: Name of the custom field. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: Creation timestamp of the object. modified_at: anyOf: - type: string format: date-time - type: 'null' title: Modified At description: Last modification timestamp of the object. id: type: string format: uuid4 title: Id description: The ID of the object. metadata: $ref: '#/components/schemas/MetadataOutputType' type: type: string const: select title: Type slug: type: string title: Slug description: >- Identifier of the custom field. It'll be used as key when storing the value. name: type: string title: Name description: Name of the custom field. organization_id: type: string format: uuid4 title: Organization Id description: The ID of the organization owning the custom field. examples: - 1dbfc517-0bbf-4301-9ba8-555ca42b9737 x-polar-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: Minimum number of seats (inclusive) max_seats: anyOf: - type: integer minimum: 1 - type: 'null' title: Max Seats description: Maximum number of seats (inclusive). None for unlimited. price_per_seat: type: integer maximum: 99999999 minimum: 0 title: Price Per Seat description: Price per seat in cents for this tier type: object required: - min_seats - price_per_seat title: ProductPriceSeatTier description: A 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: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````