v1

latestOpenAPI 3.1.02026-08-062951103.4 KB
payments

Retrieve a payment

get/payments/{id}

Path parameters

idstring required

Payment ID to retrieve

Response

OK

idstring required
type'saved' | 'deflected' required
amountstring required
currencystring required
platform_invoice_idstring required
platform_invoice_numberstring
paid_atstring date-time required

Example response

{
  "id": "pay_F1sfjrcEEdYN3ewRsoJdUseY",
  "amount": "12.99",
  "currency": "usd",
  "platform_invoice_id": "in_1RY7koITn5pi3looOluiingP",
  "platform_invoice_number": "1006",
  "subscriber": {
    "id": "subr_dRiytWmkVtSBt9mOpRaC0ca0",
    "platform_id": "cus_Jax42BBWGOWuDp",
    "name": "Jane Doe",
    "email": "jane@example.com",
    "status": "saved",
    "properties": [
      {
        "property": {
          "id": "prop_jrtpyZs1httwFFIl7V80cHwf",
          "key": "number_of_contacts",
          "name": "Number of contacts",
          "type": "number",
          "format": "number"
        },
        "formatted_value": "5,800"
      }
    ]
  },
  "subscription": {
    "id": "subn_dp79dRR5wIy1kGW4PCO41wit",
    "platform_id": "sub_JE1trB8eUAnh0r",
    "subscriber_id": "subr_GQmXBebvivMb5tHhassNV9kj",
    "mrr": "399.95",
    "status": "active",
    "properties": [
      {
        "property": {
          "id": "prop_S6A17y8S8wgKBBJbveQHpLW6",
          "key": "is_professional",
          "name": "Is professional",
          "type": "boolean",
          "format": "null"
        },
        "formatted_value": "True"
      }
    ]
  },
  "offer": {
    "id": "offr_jIGqAAUKqWM2pptJTfRuei1t",
    "name": "40% off",
    "details": {
      "interval": "month",
      "interval_count": 3
    }
  }
}