Sign in
Invoices

Find one Invoice

Retrieve an Invoice by its ID

get/invoices/{id}

Path parameters

idstring required

Response

OK

createdAtstring date-time required

The date and time when the entity was created.

updatedAtstring date-time nullable required

The date and time when the entity was last updated.

metadataobject nullable

Metadata used by merchants to store additional information about the entity.

idstring required

The ID of the invoice

status'open' | 'paid' | 'voided' required

The status of the invoice

voidedReasonstring nullable required

The reason for voiding the invoice

commentstring nullable required

An optional comment for the invoice

amountnumber required

The intended amount to pay for the invoice. The actual amount paid can differ if retrying with a percentage discount, in which case the actual amount paid can be found in payment.amount

currency'usd' | 'eur' | 'gbp' | 'cad' | 'aud' | 'pln' | 'czk' | 'sek' | 'dkk' required

The currency of the amount to be charged

type'setup' | 'recurring' required

Indicates whether the invoice is the one that sets up the subscription, or a recurring one

numberstring required

Sequential, unique, and human-readable number of the invoice

subscriptionstring nullable required

The ID of the subscription associated with this invoice

Example response

{
  "createdAt": "2024-02-18T12:00:00Z",
  "updatedAt": "2024-02-21T12:15:00Z",
  "metadata": {
    "key1": "value1",
    "key2": "value2"
  },
  "status": "open",
  "voidedReason": "Grace period expired",
  "comment": "This is a comment for the invoice",
  "amount": 999,
  "currency": "usd",
  "type": "setup",
  "number": "2W12-1004",
  "customer": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "metadata": {
      "key1": "value1",
      "key2": "value2"
    },
    "id": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "email": "user@gmail.com",
    "name": "John Doe",
    "phoneNumber": "+1234567890",
    "dateOfBirth": "2020-01-01",
    "gender": "male",
    "restrictReason": "Customer restricted due to suspicious activity",
    "isRestricted": true
  },
  "payment": {
    "createdAt": "2024-02-18T12:00:00Z",
    "updatedAt": "2024-02-21T12:15:00Z",
    "id": "pay_2QC7PqoUeOxQEWscJJt6B3PkvyL",
    "status": "succeeded",
    "displayStatus": "succeeded",
    "amount": 1500,
    "note": "This is a note for the payment",
    "currency": "usd",
    "amountCaptured": 1500,
    "isCaptured": true,
    "isRecovered": true,
    "isRetrying": true,
    "chargebackRecordedAt": "2026-01-15T10:30:00.000Z",
    "authorizedAt": "2026-01-15T10:30:00.000Z",
    "capturedAt": "2026-01-15T10:35:00.000Z",
    "reversedAt": "2026-01-20T14:00:00.000Z",
    "initiator": "customer",
    "offSessionType": "recurring",
    "statementDescriptor": "Some product",
    "latestMessage": "Payment was declined by the issuing bank.",
    "latestDeclineType": "hard_decline",
    "action": {
      "redirectUrl": "https://example.com"
    },
    "checkoutKey": "ck_live_abc123def456",
    "metadata": {},
    "attribution": {
      "utm_source": "google",
      "utm_medium": "cpc",
      "utm_campaign": "summer_sale",
      "utm_term": "running+shoes",
      "utm_content": "banner_a",
      "utm_id": "utm_123",
      "utm_contentid": "content_123",
      "ref_id": "ref_abc",
      "fbclid": "fbclid_abc",
      "cmpid": "cmp_123"
    },
    "retry": {
      "attempts": 2,
      "nextAmount": 999
    },
    "customer": {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "id": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "email": "user@gmail.com",
      "name": "John Doe",
      "phoneNumber": "+1234567890",
      "dateOfBirth": "2020-01-01",
      "gender": "male",
      "restrictReason": "Customer restricted due to suspicious activity",
      "isRestricted": true
    },
    "paymentMethod": {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "type": "card",
      "customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
      "card": {
        "brand": "amex",
        "lastFour": "1234",
        "bin": "123456",
        "expMonth": "12",
        "expYear": "2025",
        "cardholderName": "John Doe"
      },
      "applePay": {
        "displayName": "MasterCard 1234"
      }
    },
    "latestTransaction": {
      "createdAt": "2024-02-18T12:00:00Z",
      "updatedAt": "2024-02-21T12:15:00Z",
      "metadata": {
        "key1": "value1",
        "key2": "value2"
      },
      "status": "authorized",
      "authentication": "not_requested",
      "amount": 1500,
      "initiator": "customer",
      "statementDescriptor": "Hello World",
      "amountCaptured": 1500,
      "isCaptured": true,
      "chargebackRecordedAt": "2026-01-15T10:30:00.000Z",
      "captureMethod": "automatic",
      "currency": "usd",
      "processorId": "ch_1J8lZpJ9j1bSv2Jr6sVjXZ1N",
      "gatewayProfile": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "gwp_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "active": true,
        "title": "Profile #1",
        "integration": "stripe",
        "environment": "test"
      },
      "paymentMethod": {
        "createdAt": "2024-02-18T12:00:00Z",
        "updatedAt": "2024-02-21T12:15:00Z",
        "metadata": {
          "key1": "value1",
          "key2": "value2"
        },
        "id": "pm_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "type": "card",
        "customer": "cus_2QC7PqoUeOxQEWscJJt6B3PkvyL",
        "card": {
          "brand": "amex",
          "lastFour": "1234",
          "bin": "123456",
          "expMonth": "12",
          "expYear": "2025",
          "cardholderName": "John Doe"
        },
        "applePay": {
          "displayName": "MasterCard 1234"
        }
      }
    }
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1