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

# Get a charge

> Retrieve one charge by id. Requires the READ_CHARGES scope.

Returns one charge. Use it to confirm a payment after the `charges/paid` webhook.


## OpenAPI

````yaml apps-api/specs/billing.json GET /app-billing/charges/{id}
openapi: 3.1.0
info:
  title: 'Salesive Apps API: Billing'
  version: 1.0.0
  description: >-
    Charge the merchant a store is installed for, once or on a schedule. Every
    endpoint authenticates with an installed-app access token (prefix `app_`).
    Creating a charge or subscription never moves money: the store owner
    approves it in the dashboard first. Salesive keeps 5% of every payment and
    credits the rest to your payout store's wallet.
servers:
  - url: https://api.salesive.com/api/v1
    description: Production
security:
  - AppToken: []
paths:
  /app-billing/charges/{id}:
    get:
      tags:
        - Charges
      summary: Get a charge
      description: >-
        Returns one charge. A pending charge past its deadline is marked
        `expired` when you read it. Requires `READ_CHARGES`. Authenticate with
        `Authorization: Bearer app_<token>`. The store is bound to the token
        server-side, never send a shop id.
      operationId: getCharge
      parameters:
        - $ref: '#/components/parameters/ChargeId'
      responses:
        '200':
          description: The charge.
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/EnvelopeBase'
                  - type: object
                    properties:
                      data:
                        $ref: '#/components/schemas/Charge'
              example:
                status: 200
                success: true
                message: OK
                data:
                  id: 66d1f0a3c2d4e5f6a7b8c9d0
                  reference: apc_3f9a1c52d7e84b60
                  status: pending
                  name: Extra seats
                  description: 5 additional seats
                  amount: 15
                  currency: USD
                  platformFee: 0.75
                  netAmount: 14.25
                  subscriptionId: null
                  periodStart: null
                  periodEnd: null
                  test: false
                  metadata:
                    orderRef: A-1042
                  returnUrl: https://myapp.example.com/billing/done
                  confirmationUrl: >-
                    https://app.salesive.com/apps/billing/approve/apc_3f9a1c52d7e84b60
                  failureReason: null
                  expiresAt: '2026-10-27T10:30:00.000Z'
                  paidAt: null
                  createdAt: '2026-10-25T10:30:00.000Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  parameters:
    ChargeId:
      name: id
      in: path
      required: true
      description: The charge id.
      schema:
        type: string
  schemas:
    EnvelopeBase:
      type: object
      description: >-
        Standard Salesive response envelope. The operation-specific payload is
        carried in `data`.
      required:
        - status
        - success
        - message
      properties:
        status:
          type: integer
          description: HTTP status code, echoed in the body.
        success:
          type: boolean
          description: Whether the request succeeded.
        message:
          type: string
          description: Human-readable result message.
    Charge:
      type: object
      description: >-
        A payment your app asked the merchant for. A subscription's payments are
        charges too, with `subscriptionId` set.
      properties:
        id:
          type: string
        reference:
          type: string
          description: Starts with `apc_`.
        status:
          type: string
          enum:
            - pending
            - processing
            - paid
            - declined
            - expired
            - failed
          description: >-
            `pending` waits for the merchant. `paid` is final and means your
            payout store was credited (or, for a test charge, that no money was
            needed).
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        amount:
          type: number
          description: The price you set, in `currency`.
        currency:
          type: string
          enum:
            - USD
            - NGN
        platformFee:
          type: number
          description: Salesive's 5%, in `currency`.
        netAmount:
          type: number
          description: >-
            What your payout store receives, in `currency`, before conversion to
            its wallet currency.
        subscriptionId:
          type:
            - string
            - 'null'
        periodStart:
          type:
            - string
            - 'null'
          format: date-time
        periodEnd:
          type:
            - string
            - 'null'
          format: date-time
        test:
          type: boolean
          description: True on a development install. No money moves.
        metadata:
          type:
            - object
            - 'null'
          description: Whatever you sent, returned unchanged.
        returnUrl:
          type:
            - string
            - 'null'
        confirmationUrl:
          type:
            - string
            - 'null'
          description: Send the merchant here to approve. Present only while `pending`.
        failureReason:
          type:
            - string
            - 'null'
        expiresAt:
          type:
            - string
            - 'null'
          format: date-time
        paidAt:
          type:
            - string
            - 'null'
          format: date-time
        createdAt:
          type: string
          format: date-time
    Envelope:
      allOf:
        - $ref: '#/components/schemas/EnvelopeBase'
        - type: object
          properties:
            data:
              description: Operation-specific payload (object, array, or null).
  responses:
    Unauthorized:
      description: Missing or invalid app access token.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 401
            success: false
            message: Authentication required
            data: null
    Forbidden:
      description: The app token is missing the OAuth scope required for this operation.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 403
            success: false
            message: Insufficient scope
            data: null
    NotFound:
      description: >-
        The resource does not exist or does not belong to the installation's
        store.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Envelope'
          example:
            status: 404
            success: false
            message: Resource not found
            data: null
  securitySchemes:
    AppToken:
      type: http
      scheme: bearer
      description: >-
        Installed-app access token (prefix app_), issued by the OAuth install
        flow. The store is bound to the token server-side, never send a shop id.

````

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