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

# List offers



## OpenAPI

````yaml /api-reference/commerce-v1.openapi.json get /v1/commerce/offers
openapi: 3.0.3
info:
  description: >-
    Public REST API for COPE vendor integrations. Authenticate with a COPE API
    key or Clerk bearer token and call the endpoints described below.
  title: COPE Public API
  version: v1
servers:
  - description: Production
    url: https://api.cope.com
security:
  - cope_sk: []
paths:
  /v1/commerce/offers:
    get:
      tags:
        - Offers
      summary: List offers
      operationId: commerce.offers.list
      parameters:
        - description: >-
            Page number for paginated results. Values below 1 and non-numeric
            values are ignored and the first page is returned; a page past the
            last one returns the last page.
          in: query
          name: page
          required: false
          schema:
            minimum: 1
            type: integer
        - description: >-
            Number of records per page. Defaults to 12; values above 25 are
            clamped to 25; values below 1 and non-numeric values are ignored and
            the default is used.
          in: query
          name: per_page
          required: false
          schema:
            maximum: 25
            minimum: 1
            type: integer
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    items:
                      additionalProperties: false
                      properties:
                        buyer_profile:
                          additionalProperties: false
                          properties:
                            address:
                              additionalProperties: false
                              properties:
                                city:
                                  type: string
                                line1:
                                  type: string
                                line2:
                                  nullable: true
                                  type: string
                                postal_code:
                                  type: string
                              required:
                                - city
                                - line1
                                - line2
                                - postal_code
                              type: object
                            company_name:
                              nullable: true
                              type: string
                            country:
                              nullable: true
                              type: string
                            email:
                              type: string
                            first_name:
                              nullable: true
                              type: string
                            last_name:
                              nullable: true
                              type: string
                            locale:
                              type: string
                            phone:
                              description: >-
                                Buyer's phone number, as captured when the offer
                                was created.
                              nullable: true
                              type: string
                            state:
                              nullable: true
                              type: string
                            type:
                              type: string
                            vat_id:
                              nullable: true
                              type: string
                          required:
                            - type
                            - email
                            - state
                            - locale
                            - vat_id
                            - address
                            - country
                            - last_name
                            - first_name
                            - company_name
                          type: object
                        cancelled_at:
                          nullable: true
                          type: string
                        cancelled_reason:
                          nullable: true
                          type: string
                        created_at:
                          type: string
                        embed_origin:
                          description: >-
                            The one origin allowed to frame `embed_url`. Absent
                            — not null — when the offer cannot be framed.
                          pattern: ^https://[^@/?#\s]+$
                          type: string
                        embed_url:
                          description: >-
                            Pass to the Checkout SDK's `mountCheckout` on
                            `embed_origin` to open this offer's checkout inside
                            your own page. The framed page waits for the SDK's
                            mount handshake, so a bare iframe never loads. The
                            same checkout `public_url` redirects to, not a
                            second one. Absent — not null — when the offer
                            cannot be framed.
                          type: string
                        expires_at:
                          description: >-
                            When the offer link stops working. Null when the
                            offer never expires, which is what an offer created
                            without `link_expiration` gets.
                          nullable: true
                          type: string
                        id:
                          example: of_A1b2C3d4E5f6
                          pattern: ^of_[A-Za-z0-9]{8,32}$
                          type: string
                        last_buyer_notification_at:
                          nullable: true
                          type: string
                        next_resend_available_at:
                          nullable: true
                          type: string
                        order:
                          additionalProperties: false
                          nullable: true
                          properties:
                            id:
                              example: ord_A1b2C3d4E5f6
                              pattern: ^ord_[A-Za-z0-9]{8,32}$
                              type: string
                          required:
                            - id
                          type: object
                        ordered_at:
                          nullable: true
                          type: string
                        payment_plan_snapshot:
                          additionalProperties: false
                          properties:
                            currency:
                              type: string
                            custom_plan_name:
                              nullable: true
                              type: string
                            installment_count:
                              nullable: true
                              type: integer
                            interval:
                              nullable: true
                              type: string
                            interval_count:
                              nullable: true
                              type: integer
                            plan_type:
                              type: string
                            price_minor_units:
                              type: integer
                            quantity:
                              type: integer
                            recurring_amount_minor_units:
                              nullable: true
                              type: integer
                            second_payment_in:
                              nullable: true
                              type: integer
                            shipping_price_minor_units:
                              nullable: true
                              type: integer
                            trial_days:
                              nullable: true
                              type: integer
                          required:
                            - plan_type
                            - currency
                            - quantity
                            - price_minor_units
                            - shipping_price_minor_units
                            - recurring_amount_minor_units
                            - interval
                            - interval_count
                            - installment_count
                            - second_payment_in
                            - trial_days
                            - custom_plan_name
                          type: object
                        product:
                          additionalProperties: false
                          nullable: true
                          properties:
                            id:
                              example: prod_A1b2C3d4
                              pattern: ^prod_[A-Za-z0-9]{8,32}$
                              type: string
                            name:
                              type: string
                          required:
                            - id
                            - name
                          type: object
                        public_url:
                          type: string
                        regeneration_eligible:
                          type: boolean
                        status:
                          type: string
                      required:
                        - buyer_profile
                        - cancelled_at
                        - cancelled_reason
                        - created_at
                        - expires_at
                        - id
                        - last_buyer_notification_at
                        - next_resend_available_at
                        - order
                        - ordered_at
                        - payment_plan_snapshot
                        - product
                        - public_url
                        - regeneration_eligible
                        - status
                      type: object
                    type: array
                  pagination:
                    additionalProperties: false
                    properties:
                      current_page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                      total_pages:
                        type: integer
                    required:
                      - total_pages
                      - current_page
                      - per_page
                      - total_count
                    type: object
                required:
                  - data
                  - pagination
                type: object
          description: Successful response
        '400':
          content:
            application/problem+json:
              examples:
                unparsable_request:
                  summary: Unparsable request
                  value:
                    code: invalid_request
                    detail: >-
                      The request could not be parsed. Check the query string
                      and the request body.
                    request_id: req_123
                    status: 400
                    title: Invalid Request
                    type: https://docs.cope.com/errors/invalid_request
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Invalid request
        '401':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Missing or invalid bearer token
        '403':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Bearer token is not authorized for this route
      security:
        - cope_sk: []
components:
  schemas:
    PublicProblemDetail:
      additionalProperties: false
      properties:
        code:
          type: string
        detail:
          nullable: true
          type: string
        errors:
          items:
            additionalProperties: false
            properties:
              code:
                type: string
              detail:
                type: string
              param:
                type: string
            required:
              - code
              - detail
            type: object
          type: array
        request_id:
          type: string
        status:
          type: integer
        title:
          type: string
        type:
          type: string
      required:
        - type
        - title
        - status
        - code
        - request_id
      type: object
  securitySchemes:
    cope_sk:
      description: >-
        Bearer credential for the public API. Vendor integrations should send a
        live COPE API key (`ck_live_*`; keys issued earlier as `cope_sk_live_*`
        keep working). Clerk bearer tokens are also accepted when paired with
        `X-Cope-Business-Id`.
      scheme: bearer
      type: http

````