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

# Retrieve a checkout

> Returns a checkout you created. `order` names the order the buyer's payment made once it
succeeded, and is null until then; `status` reads `completed` whenever `order` is set. A
checkout expires 30 minutes after it was created.

Requires the `orders` permission at `read`. An API key holds a permission at the lower of its own level (`read` for a read-only key) and its holder's role; a key without it is refused with 403.



## OpenAPI

````yaml /api-reference/commerce-v1.openapi.json get /v1/commerce/checkouts/{id}
openapi: 3.0.3
info:
  description: >-
    Public REST API for COPE vendor integrations. Authenticate with a COPE API
    key 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/checkouts/{id}:
    get:
      tags:
        - Checkouts
      summary: Retrieve a checkout
      description: >-
        Returns a checkout you created. `order` names the order the buyer's
        payment made once it

        succeeded, and is null until then; `status` reads `completed` whenever
        `order` is set. A

        checkout expires 30 minutes after it was created.


        Requires the `orders` permission at `read`. An API key holds a
        permission at the lower of its own level (`read` for a read-only key)
        and its holder's role; a key without it is refused with 403.
      operationId: commerce.checkouts.retrieve
      parameters:
        - description: id public identifier.
          example: chk_A1b2C3d4E5f6G7h8
          in: path
          name: id
          required: true
          schema:
            example: chk_A1b2C3d4E5f6G7h8
            pattern: ^chk_[A-Za-z0-9]{8,32}$
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                additionalProperties: false
                properties:
                  data:
                    additionalProperties: false
                    properties:
                      buyer_email_locked:
                        type: boolean
                      cancel_url:
                        nullable: true
                        type: string
                      checkout_url:
                        description: 'Returned by create only: COPE stores a digest of it.'
                        format: uri
                        type: string
                      created_at:
                        format: date-time
                        type: string
                      embed_origin:
                        description: Returned by create only, when embeddable.
                        type: string
                      embed_url:
                        description: Returned by create only, when embeddable.
                        format: uri
                        type: string
                      expires_at:
                        format: date-time
                        type: string
                      external_reference:
                        nullable: true
                        type: string
                      id:
                        example: chk_A1b2C3d4E5f6G7h8
                        pattern: ^chk_[A-Za-z0-9]{8,32}$
                        type: string
                      metadata:
                        allOf:
                          - $ref: '#/components/schemas/CommerceMerchantMetadata'
                        description: Your own keys the checkout carries, as you sent them.
                      object:
                        enum:
                          - checkout
                        type: string
                      order:
                        additionalProperties: false
                        nullable: true
                        properties:
                          id:
                            example: ord_A1b2C3d4E5f6
                            pattern: ^ord_[A-Za-z0-9]{8,32}$
                            type: string
                          object:
                            enum:
                              - order
                            type: string
                        required:
                          - object
                          - id
                        type: object
                      status:
                        enum:
                          - open
                          - completed
                          - expired
                          - cancelled
                        type: string
                      success_url:
                        nullable: true
                        type: string
                      totals:
                        additionalProperties: false
                        properties:
                          currency:
                            type: string
                          discount_minor_units:
                            type: integer
                          shipping_minor_units:
                            type: integer
                          subtotal_minor_units:
                            type: integer
                          tax_minor_units:
                            type: integer
                          total_minor_units:
                            type: integer
                        type: object
                    required:
                      - object
                      - id
                      - status
                      - created_at
                      - expires_at
                      - success_url
                      - cancel_url
                      - external_reference
                      - metadata
                      - buyer_email_locked
                      - totals
                      - order
                    type: object
                required:
                  - data
                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: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    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
        '404':
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: Resource not found
        '503':
          content:
            application/problem+json:
              examples:
                user_not_ready:
                  summary: The key's user is not available yet
                  value:
                    code: user_not_ready
                    detail: Retry after 2 seconds
                    errors:
                      - code: user_not_ready
                        detail: Retry after 2 seconds
                    request_id: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    status: 503
                    title: User Not Ready
                    type: https://docs.cope.com/errors/user_not_ready
                tenant_not_ready:
                  summary: The key's business is not available yet
                  value:
                    code: tenant_not_ready
                    detail: Retry after 2 seconds
                    errors:
                      - code: tenant_not_ready
                        detail: Retry after 2 seconds
                    request_id: 0b6e3f2a-8c4d-4f1e-9a7b-5d2c8e1f4a90
                    status: 503
                    title: Tenant Not Ready
                    type: https://docs.cope.com/errors/tenant_not_ready
              schema:
                $ref: '#/components/schemas/PublicProblemDetail'
          description: >-
            The API key is valid but its user or business is not available to
            this API yet (`user_not_ready`, `tenant_not_ready`). Retry after the
            `Retry-After` seconds.
      security:
        - cope_sk: []
components:
  schemas:
    CommerceMerchantMetadata:
      additionalProperties: true
      description: >-
        Key-value data of your own. Values may be strings, numbers, booleans,
        null, arrays and objects.
      maxProperties: 50
      type: object
    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:
          description: >-
            Correlates this response with COPE's logs; the response also carries
            it as `X-Request-Id`. It is the `X-Request-Id` you sent when that is
            1-128 letters, digits, `_`, `@` or `-`, and otherwise one COPE
            generated. Quote it when you contact support.
          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: a live COPE API key (`ck_live_*`;
        keys issued earlier as `cope_sk_live_*` keep working). Dashboard sign-in
        tokens are not accepted.
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.