> ## Documentation Index
> Fetch the complete documentation index at: https://help.kajabi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Offer details

> The offer system is a core part of Kajabi's e-commerce functionality, allowing course creators and digital product owners to monetize their content through various pricing and payment models while maintaining flexibility in how offers are presented and processed.

## Offer attributes
* `title` (string) - Required, public name of the offer shown to customers
* `description` (string) - Optional, detailed information about what's included in the offer
* `internal_title` (string) - Optional, for internal reference/organization (not shown to customers)
* `currency` (string) - The currency of the offer, defaults to USD
* `price_in_cents` (integer) - The USD price in cents (for precise decimal handling)
* `payment_type` (string) - Indicates the payment structure
* `token` (string) - A unique identifier for the offer, particularly in checkout URLs
* `payment_method` (string) - Indicates the payment method, Returns empty string if no payment method is set
* `price_description` (string) - Human-readable representation of the offer's price, includes formatting and currency information
* `checkout_url` (string) - Full URL where customers can purchase the offer
  * Includes the offer token for identification
  * Uses the site's public host and protocol settings
* `recurring_offer` (boolean) - Whether the offer has recurring payments
* `subscription` (boolean) - Whether the offer is a subscription offer
* `one_time` (boolean) - Whether the offer is a one-time offer
* `single` (boolean) - Whether the offer is a single offer
* `free` (boolean) - Whether the offer is a free offer
* `image_url` (string) - URL to the image associated with the offer (nullable)

## Include Relationships
Use the `include` parameter to include related products:
* `GET /v1/offers/123?include=products`

Response will include products relationship
```json
{
  "data": {
    "id": "123",
    "type": "offers",
    "attributes": {
      "title": "Advanced Course Bundle",
      "description": "Complete advanced course bundle with expert guidance",
      "internal_title": "advanced_course_bundle",
      "currency": "USD",
      "price_in_cents": 19900,
      "payment_type": "stripe",
      "token": "123",
      "payment_method": "stripe",
      "price_description": "$199.00",
      "checkout_url": "https://api.kajabi.com/checkout/123",
      "recurring_offer": false,
      "subscription": false,
      "one_time": true,
      "single": true,
      "free": false,
      "image_url": "https://api.kajabi.com/images/456"
    },
    "relationships": {
      "products": {
        "data": [
          {
            "id": "456",
            "type": "products"
          }
        ]
      }
    }
  },
  "included": [
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "created_at": "2021-01-01T00:00:00Z",
        "title": "Advanced Course",
        "description": "Complete advanced course with expert guidance",
        "status": "ready",
        "members_aggregate_count": 100,
        "product_type_name": "Course",
        "product_type_id": 456,
        "publish_status": "published",
        "image_url": "https://api.kajabi.com/images/456"
      }
    }
  ]
}
```
## Sparse Fields
### Only return title and price_in_cents attributes
* `GET /v1/offers/123?fields[offers]=title,price_in_cents`

Response will only include requested fields
```json
{
  "data": {
    "id": "123",
    "type": "offers",
    "attributes": {
      "title": "Advanced Course Bundle",
      "price_in_cents": 19900
    }
  }
}
```

## Multiple parameters together
You can combine include and sparse fields in a single request:
### Get offer 123 with products, including only title and description fields, and products with title and publish_status fields
* `GET /v1/offers/123?include=products&fields[offers]=title,description&fields[products]=title,publish_status`

Response will include offer and products with sparse fields
```json
{
  "data": {
    "id": "123",
    "type": "offers",
    "attributes": {
      "title": "Advanced Course Bundle",
      "description": "Complete advanced course bundle with expert guidance"
    },
    "relationships": {}
  },
  "included": [
    {
      "id": "456",
      "type": "products",
      "attributes": {
        "title": "Advanced Course",
        "publish_status": "published"
      }
    }
  ]
}
```




## OpenAPI

````yaml /openapi.yaml get /v1/offers/{id}
openapi: 3.1.1
info:
  title: Kajabi API V1
  version: 1.0.1
  description: >
    ## Public API

    * Server URL `https://api.kajabi.com`

    * Endpoint paths are prefixed with `/v1`

    * Version endpoint `GET https://api.kajabi.com/v1/version`

    * See the [Developers Site](https://developers.kajabi.com) for documentation
    and examples.

    * Try the demo [Postman
    collection](https://www.postman.com/kajabi-apis/beta-public-api-demo/collection/fg4iyaz/kajabi-public-api-v1)

    ## API Keys

    * Your API `client_id` and `client_secret` are available on the [User API
    Keys](https://app.kajabi.com/admin/settings/security) section of the Kajabi
    Admin Portal.
      * Custom API Keys can be created with specific permissions.
      * Click the "Create User API Key" button, enter a name (e.g. "My project"), select the user and permissions, and click "Create".
      * For security purposes, you may "Delete" or "Rotate" the api credentials at any time; which will invalidate any access tokens granted with the credentials.
    ## Video Walkthroughs

    *
    [Capabilities](https://drive.google.com/file/d/1Puc9B2sSdA-RQb7YMxmUXg4FVoEXytoc/view?usp=sharing)

    * [Getting
    Started](https://drive.google.com/file/d/1hbGRShkxven_QMWvgYrerHKURbcZrnvJ/view?usp=sharing)

    * [Error
    Examples](https://drive.google.com/file/d/1i0wQK71I1jpaZVsxYwsn62gVj40S_E7Y/view?usp=sharing)

    * [External Contact
    Form](https://drive.google.com/file/d/1HqpULXvan5TOK3LvM7nILCuCkCaX0kFT/view?usp=sharing)
  contact:
    email: support@kajabi.com
    name: Support
    url: >-
      https://help.kajabi.com/hc/en-us/articles/4404549690523-How-to-Get-Help-From-Kajabi-Live-Agents
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
  - url: https://api.kajabi.com
    description: Production
security: []
paths:
  /v1/offers/{id}:
    get:
      tags:
        - Offers
      summary: Offer details
      description: >
        The offer system is a core part of Kajabi's e-commerce functionality,
        allowing course creators and digital product owners to monetize their
        content through various pricing and payment models while maintaining
        flexibility in how offers are presented and processed.


        ## Offer attributes

        * `title` (string) - Required, public name of the offer shown to
        customers

        * `description` (string) - Optional, detailed information about what's
        included in the offer

        * `internal_title` (string) - Optional, for internal
        reference/organization (not shown to customers)

        * `currency` (string) - The currency of the offer, defaults to USD

        * `price_in_cents` (integer) - The USD price in cents (for precise
        decimal handling)

        * `payment_type` (string) - Indicates the payment structure

        * `token` (string) - A unique identifier for the offer, particularly in
        checkout URLs

        * `payment_method` (string) - Indicates the payment method, Returns
        empty string if no payment method is set

        * `price_description` (string) - Human-readable representation of the
        offer's price, includes formatting and currency information

        * `checkout_url` (string) - Full URL where customers can purchase the
        offer
          * Includes the offer token for identification
          * Uses the site's public host and protocol settings
        * `recurring_offer` (boolean) - Whether the offer has recurring payments

        * `subscription` (boolean) - Whether the offer is a subscription offer

        * `one_time` (boolean) - Whether the offer is a one-time offer

        * `single` (boolean) - Whether the offer is a single offer

        * `free` (boolean) - Whether the offer is a free offer

        * `image_url` (string) - URL to the image associated with the offer
        (nullable)


        ## Include Relationships

        Use the `include` parameter to include related products:

        * `GET /v1/offers/123?include=products`


        Response will include products relationship

        ```json

        {
          "data": {
            "id": "123",
            "type": "offers",
            "attributes": {
              "title": "Advanced Course Bundle",
              "description": "Complete advanced course bundle with expert guidance",
              "internal_title": "advanced_course_bundle",
              "currency": "USD",
              "price_in_cents": 19900,
              "payment_type": "stripe",
              "token": "123",
              "payment_method": "stripe",
              "price_description": "$199.00",
              "checkout_url": "https://api.kajabi.com/checkout/123",
              "recurring_offer": false,
              "subscription": false,
              "one_time": true,
              "single": true,
              "free": false,
              "image_url": "https://api.kajabi.com/images/456"
            },
            "relationships": {
              "products": {
                "data": [
                  {
                    "id": "456",
                    "type": "products"
                  }
                ]
              }
            }
          },
          "included": [
            {
              "id": "456",
              "type": "products",
              "attributes": {
                "created_at": "2021-01-01T00:00:00Z",
                "title": "Advanced Course",
                "description": "Complete advanced course with expert guidance",
                "status": "ready",
                "members_aggregate_count": 100,
                "product_type_name": "Course",
                "product_type_id": 456,
                "publish_status": "published",
                "image_url": "https://api.kajabi.com/images/456"
              }
            }
          ]
        }

        ```

        ## Sparse Fields

        ### Only return title and price_in_cents attributes

        * `GET /v1/offers/123?fields[offers]=title,price_in_cents`


        Response will only include requested fields

        ```json

        {
          "data": {
            "id": "123",
            "type": "offers",
            "attributes": {
              "title": "Advanced Course Bundle",
              "price_in_cents": 19900
            }
          }
        }

        ```


        ## Multiple parameters together

        You can combine include and sparse fields in a single request:

        ### Get offer 123 with products, including only title and description
        fields, and products with title and publish_status fields

        * `GET
        /v1/offers/123?include=products&fields[offers]=title,description&fields[products]=title,publish_status`


        Response will include offer and products with sparse fields

        ```json

        {
          "data": {
            "id": "123",
            "type": "offers",
            "attributes": {
              "title": "Advanced Course Bundle",
              "description": "Complete advanced course bundle with expert guidance"
            },
            "relationships": {}
          },
          "included": [
            {
              "id": "456",
              "type": "products",
              "attributes": {
                "title": "Advanced Course",
                "publish_status": "published"
              }
            }
          ]
        }

        ```
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
        - name: include
          in: query
          required: false
          description: Load the related resources, for example ?include=products
          schema:
            type: string
        - name: fields[offers]
          in: query
          required: false
          description: >-
            Partial attributes as specified, e.g.
            fields[offers]=title,price_in_cents
          schema:
            type: string
      responses:
        '200':
          description: Success, shows details of an offer
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/offers_show_response'
        '401':
          description: Unauthorized, Authorization header is missing or invalid
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_unauthorized'
        '403':
          description: Forbidden, insufficient permission to access the resource
          content:
            application/vnd.api+json:
              schema:
                $ref: '#/components/schemas/errors_forbidden'
      security:
        - Bearer: []
components:
  schemas:
    offers_show_response:
      type: object
      properties:
        data:
          type: object
          properties:
            id:
              type: string
            type:
              type: string
            attributes:
              $ref: '#/components/schemas/offers_attributes'
            relationships:
              type: object
              properties:
                site:
                  type: object
                  properties:
                    data:
                      $ref: '#/components/schemas/resource_identifier'
                products:
                  type: object
                  properties:
                    data:
                      type: array
                      items:
                        $ref: '#/components/schemas/resource_identifier'
        links:
          type: object
          properties:
            self:
              type: string
            current:
              type: string
    errors_unauthorized:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors_attributes'
    errors_forbidden:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/errors_attributes'
    offers_attributes:
      type: object
      properties:
        title:
          type: string
        description:
          type:
            - string
            - 'null'
        internal_title:
          type:
            - string
            - 'null'
        currency:
          type: string
        price_in_cents:
          type: integer
        payment_type:
          type: string
        token:
          type: string
        payment_method:
          type: string
        price_description:
          type: string
        checkout_url:
          type: string
        recurring_offer:
          type: boolean
        subscription:
          type: boolean
        one_time:
          type: boolean
        single:
          type: boolean
        free:
          type: boolean
        image_url:
          type:
            - string
            - 'null'
      required:
        - title
    resource_identifier:
      type: object
      properties:
        id:
          type: string
        type:
          type: string
      required:
        - id
        - type
    errors_attributes:
      type: object
      properties:
        status:
          type: string
        source:
          type: object
          nullable: true
          properties:
            pointer:
              type: string
        title:
          type: string
        detail:
          type: string
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer

````