v4

latestSwagger 2.02026-08-0343714211.7 MB

payments

Account Line Items

Show Payment

get/payments/{id}

Path parameters

idinteger required

Payment ID.

Response

The Payments object.

idinteger

Line item Id

amountstring decimal

Line item amount

balancestring decimal

Line item balance

created_atstring date-time

Line item created at

currencystring

Line item currency

download_uristring

Line item download uri

methodstring

Line item payment method

payment_reversed_atstring date-time

Date/time payment was reversed if applicable

payment_typestring

Type of payment if applicable

site_namestring

Site name this line item is for

typestring

Type of line item, either payment or invoice

Example response

{
  "id": 1,
  "amount": "1.0",
  "balance": "1.0",
  "created_at": "2000-01-01T01:00:00Z",
  "currency": "USD",
  "download_uri": "https://url...",
  "invoice_line_items": [
    {
      "id": 1,
      "amount": "1.0",
      "created_at": "2000-01-01T01:00:00Z",
      "description": "Service from 2019-01-01 through 2019-12-31",
      "type": "invoice",
      "service_end_at": "2000-01-01T01:00:00Z",
      "service_start_at": "2000-01-01T01:00:00Z",
      "plan": "Enterprise",
      "site": "My site",
      "prepaid_bytes": 1,
      "prepaid_bytes_expire_at": "2000-01-01T01:00:00Z",
      "prepaid_bytes_used": 1,
      "prepaid_bytes_available": 1
    }
  ],
  "method": "paypal",
  "payment_line_items": [
    {
      "amount": "1.0",
      "created_at": "2000-01-01T01:00:00Z",
      "invoice_id": 1,
      "payment_id": 1
    }
  ],
  "payment_reversed_at": "2000-01-01T01:00:00Z",
  "payment_type": "example",
  "site_name": "My Site",
  "type": "invoice"
}