Skip to main content
GET
/
payments
/
{paymentId}
{
  "paymentId": "64870b5c-fb61-4c9a-955a-e148e0826c20",
  "status": "PAID",
  "amount": 29,
  "currency": "USD",
  "lineItems": [
    {
      "description": "Mobile subscription - Premium Plan",
      "subscriptionId": "a8174435-6378-4be5-a9f5-8b4aaadae5d4",
      "licenseId": "ffb19d4f-b3b6-4f2b-9365-dd80bdcf0a77",
      "productOfferingId": "mobile-plan-premium",
      "quantity": 1,
      "unitPrice": 29.99,
      "subtotal": 29.99,
      "total": 39.74,
      "taxBreakdown": [
        {
          "type": "PRODUCT_OFFERING",
          "productOfferingId": "mobile-plan-premium"
        }
      ],
      "taxAmount": 2.4,
      "taxIncluded": false,
      "fees": [
        {
          "name": "Processing fee",
          "amount": 2.5
        }
      ],
      "totalFees": 2.5,
      "discounts": [
        {
          "name": "Early bird discount",
          "amount": 5
        }
      ],
      "totalDiscounts": 5
    }
  ],
  "paymentProfileId": "f02c65e2-4ae5-4e07-9560-5b634d088d91",
  "receiptUrl": "https://payments.example.com/receipts/pay_abc123",
  "createdAt": "2024-01-15T10:00:00Z",
  "updatedAt": "2024-01-15T10:00:00Z",
  "metadata": {}
}

Authorizations

​
X-API-Key
string
header
required

An API key that grants access to the Connect API. You can create and manage API keys in the portal.

Path Parameters

​
paymentId
string
required

The unique identifier of the payment to retrieve.

Response

Payment retrieved successfully

A payment record with detailed line item breakdown and status information.

​
paymentId
string
required

Unique identifier for the payment.

Example:

"64870b5c-fb61-4c9a-955a-e148e0826c20"

​
status
enum<string>
required

Current status of a payment in its lifecycle.

Available options:
PENDING,
PAID,
FAILED,
REFUNDED,
CANCELED
Example:

"PAID"

​
amount
number
required

Payment amount.

Example:

29

​
currency
string
required

Payment currency.

Example:

"USD"

​
lineItems
object[]
required

Detailed breakdown of items included in this payment.

​
createdAt
string<date-time>
required

When the payment was created.

Example:

"2024-01-15T10:00:00Z"

​
updatedAt
string<date-time>
required

When the payment was last updated.

Example:

"2024-01-15T10:00:00Z"

​
paymentProfileId
string

Identifier of the payment profile used, if any.

Example:

"f02c65e2-4ae5-4e07-9560-5b634d088d91"

​
receiptUrl
string<uri>

URL to the payment receipt, if available.

Example:

"https://payments.example.com/receipts/pay_abc123"

​
metadata
object

A set of key-value pairs that can be attached to an object for storing additional information in a semi-structured format.

⌘I