payment_method_expiring

Collection: payment_methods_expiring

This resource shows you a customer payment card which is soon to expire.

Required Scopes

Full store_full_access
Read reporting_read
Write reporting_write

Actions

GET View a payment method expiring
HEAD Get just the header response
OPTIONS Get a response explaining which HTTP methods are supported

Properties (10)

months_before_expiration Number · Read-only

Months from today's date before this payment card will expire.

first_name String · Read-only

The customer's given name.

last_name String · Read-only

The customer's surname.

email String · Read-only

The customer's email address.

cc_type String · Read-only

The credit card or debit card type.

cc_number_masked String · Read-only

A masked version of this payment card showing only the last 4 digits.

cc_exp_month String · Read-only

The payment card expiration month in the MM format.

cc_exp_year String · Read-only

The payment card expiration year in the YYYY format.

date_created String (nullable) · Read-only

The date this resource was created.

date_modified String (nullable) · Read-only

The date this resource was last modified.

Link Relations (6)

self Payment Method Expiring
fx:store GET PATCH PUT DELETE This Store
fx:customer GET PATCH PUT DELETE This Customer
fx:default_billing_address GET PATCH PUT Default Billing Address for this Customer
fx:default_payment_method GET PATCH PUT Default Payment Method for this Customer
fx:subscriptions GET Subscriptions for this Customer
https://api.foxycart.com/payment_methods_expiring/{id}

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/payment_methods_expiring/123",
      "title": "Payment Method Expiring"
    },
    "fx:store": {
      "href": "https://api.foxycart.com/stores/456",
      "title": "This Store"
    },
    "fx:customer": {
      "href": "https://api.foxycart.com/customers/123",
      "title": "This Customer"
    },
    "fx:default_billing_address": {
      "href": "https://api.foxycart.com/customers/123/default_billing_address",
      "title": "Default Billing Address for this Customer"
    },
    "fx:default_payment_method": {
      "href": "https://api.foxycart.com/customers/123/default_payment_method",
      "title": "Default Payment Method for this Customer"
    },
    "fx:subscriptions": {
      "href": "https://api.foxycart.com/stores/456/subscriptions?customer_id=123",
      "title": "Subscriptions for this Customer"
    }
  },
  "months_before_expiration": 75,
  "first_name": "Test",
  "last_name": "User",
  "email": "luke.stokes+apitest998@example.com",
  "cc_type": "Visa",
  "cc_number_masked": "xxxxxxxxxxxx1111",
  "cc_exp_month": "12",
  "cc_exp_year": "2020",
  "date_created": null,
  "date_modified": "2013-08-16T14:13:54-0700"
}