> ## 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. # Get Discount > Get a discount by ID. **Scopes**: `discounts:read` `discounts:write` ## OpenAPI ````yaml get /v1/discounts/{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/discounts/{id}: get: tags: - discounts - public summary: Get Discount description: |- Get a discount by ID. **Scopes**: `discounts:read` `discounts:write` operationId: discounts:get parameters: - name: id in: path required: true schema: type: string format: uuid4 description: The discount ID. title: Id description: The discount ID. responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/Discount' title: Discount '404': description: Discount not found. content: application/json: schema: $ref: '#/components/schemas/ResourceNotFound' '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\"log\"\n\t\"github.com/polarsource/polar-go/models/components\"\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.Discounts.Get(ctx, \"\")\n if err != nil {\n log.Fatal(err)\n }\n if res.Discount != nil {\n switch res.Discount.Type {\n case components.DiscountUnionTypeDiscountFixedOnceForeverDuration:\n // res.Discount.DiscountFixedOnceForeverDuration is populated\n case components.DiscountUnionTypeDiscountFixedRepeatDuration:\n // res.Discount.DiscountFixedRepeatDuration is populated\n case components.DiscountUnionTypeDiscountPercentageOnceForeverDuration:\n // res.Discount.DiscountPercentageOnceForeverDuration is populated\n case components.DiscountUnionTypeDiscountPercentageRepeatDuration:\n // res.Discount.DiscountPercentageRepeatDuration is populated\n }\n\n }\n}" - lang: python label: Python (SDK) source: |- from polar_sdk import Polar with Polar( access_token="", ) as polar: res = polar.discounts.get(id="") # 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.discounts.get({ id: "", }); console.log(result); } run(); - lang: php label: PHP (SDK) source: |- declare(strict_types=1); require 'vendor/autoload.php'; use Polar; $sdk = Polar\Polar::builder() ->setSecurity( '' ) ->build(); $response = $sdk->discounts->get( id: '' ); if ($response->discount !== null) { // handle response } components: schemas: Discount: oneOf: - $ref: '#/components/schemas/DiscountFixedOnceForeverDuration' - $ref: '#/components/schemas/DiscountFixedRepeatDuration' - $ref: '#/components/schemas/DiscountPercentageOnceForeverDuration' - $ref: '#/components/schemas/DiscountPercentageRepeatDuration' ResourceNotFound: properties: error: type: string const: ResourceNotFound title: Error examples: - ResourceNotFound detail: type: string title: Detail type: object required: - error - detail title: ResourceNotFound HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError DiscountFixedOnceForeverDuration: 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 products: items: $ref: '#/components/schemas/DiscountProduct' type: array title: Products 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 - products title: DiscountFixedOnceForeverDuration description: Schema for a fixed amount discount that is applied once or forever. DiscountFixedRepeatDuration: 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 products: items: $ref: '#/components/schemas/DiscountProduct' type: array title: Products 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 - products title: DiscountFixedRepeatDuration description: |- Schema for a fixed amount discount that is applied on every invoice for a certain number of months. DiscountPercentageOnceForeverDuration: 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 products: items: $ref: '#/components/schemas/DiscountProduct' type: array title: Products 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 - products title: DiscountPercentageOnceForeverDuration description: Schema for a percentage discount that is applied once or forever. DiscountPercentageRepeatDuration: 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 products: items: $ref: '#/components/schemas/DiscountProduct' type: array title: Products 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 - products title: DiscountPercentageRepeatDuration description: |- Schema for a percentage discount that is applied on every invoice for a certain number of months. 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 DiscountDuration: type: string enum: - once - forever - repeating title: DiscountDuration DiscountType: type: string enum: - fixed - percentage title: DiscountType MetadataOutputType: additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object DiscountProduct: properties: metadata: $ref: '#/components/schemas/MetadataOutputType' 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. type: object required: - metadata - id - created_at - modified_at - trial_interval - trial_interval_count - name - description - visibility - recurring_interval - recurring_interval_count - is_recurring - is_archived - organization_id title: DiscountProduct description: A product that a discount can be applied to. TrialInterval: type: string enum: - day - week - month - year title: TrialInterval ProductVisibility: type: string enum: - draft - private - public title: ProductVisibility SubscriptionRecurringInterval: type: string enum: - day - week - month - year title: SubscriptionRecurringInterval securitySchemes: access_token: type: http scheme: bearer description: >- You can generate an **Organization Access Token** from your organization's settings. ````