Purchase details

Details of a purchase (of an offer)

Purchase Attributes

• amount_in_cents (integer) - Price of the purchase in cents
• payment_type (string) - Type of payment
• trial (integer) - Number of trial days. (subscription and payment plans only)
• trial_end_at (string) - Date the trial ends
• multipay_payments_made (integer) - Number of payments made
• payment_plan_total_payments (integer) - Total number of payments in the payment plan
• status (string) - The status of the purchase. For one-time purchases this will match the transaction detail status. For subscriptions and payment plans this status represents the status of the plan as compared to the transaction status which represents the individual payment.
• opt_in (boolean) - Whether the purchase was opt-in
• raw_extra_contact_information (object) - Extra contact information
• currency (string) - Currency of the purchase
• effective_start_at (string) - Start date of the purchase
• cardholder_name (string) - Name of the cardholder
• billing_address_zip (string) - Zip code of the billing address
• deactivated_at (string) - Date and time the purchase was deactivated
• deactivation_reason (string) - Reason for deactivation
• coupon_code (string) - Coupon code used for the purchase
• source (string) - Source of the purchase
• referrer (string) - Referrer of the purchase
• quantity (integer) - Quantity of the purchase
• created_at (string) - Date and time the purchase was created
• updated_at (string) - Date and time the purchase was updated_at

Sparse Fields

Only return amount_in_cents and multipay_payments_made attributes

• GET /v1/purchases/123?fields[purchases]=amount_in_cents,multipay_payments_made

Response will only include requested fields

{
  "data": {
    "id": "123",
    "type": "purchases",
    "attributes": {
      "amount_in_cents": 19900,
      "multipay_payments_made": 1
    }
  }
}