payment_methods_expiring

Description

This link relationship returns a collection of resources. You can easily paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last. Scroll down to view a representation of a single resource embedded within this collection.

By default, it includes payment cards which will expire next month. You can also optionally specify a months_before_expiration filter to specify how many months out for payment card expiration dates you'd like to include.

Actions

GET
View a list of payment_methods_expiring
HEAD
Get just the header response
OPTIONS
Get a response explaining which HTTP methods are supported

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "...",
      "title": "This Collection"
    },
    "first": {
      "href": "...?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "...?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "...?offset=0",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "...?offset=0",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:payment_methods_expiring": [...]
  },
  "total_items": "5",
  "returned_items": 5,
  "limit": 20,
  "offset": 0
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="...">
  <link rel="self" href="..." title="This Collection"/>
  <link rel="first" href="...?offset=0" title="First Page of this Collection"/>
  <link rel="prev" href="...?offset=0" title="Previous Page of this Collection"/>
  <link rel="next" href="...?offset=0" title="Next Page of this Collection"/>
  <link rel="last" href="...?offset=0" title="Last Page of this Collection"/>
  <resource href="..." rel="https://api.foxycart.com/rels/payment_methods_expiring">
  ...
  </resource>
  <total_items>5</total_items>
  <returned_items>5</returned_items>
  <limit>20</limit>
  <offset>0</offset>
</resource>

{
    "properties": {
        "total_items": "5",
        "returned_items": 5,
        "limit": 20,
        "offset": 0
    },
    "entities": [...],
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "..."
        },
        {
            "rel": [
                "first"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "prev"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "next"
            ],
            "href": "...?offset=0"
        },
        {
            "rel": [
                "last"
            ],
            "href": "...?offset=0"
        }
    ],
    "actions": [
    ]
}

Embedded Resource: payment_methods_expiring

Description

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

Actions

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

Properties

Property Description Type Constraints
months_before_expiration Months from today's day before this payment card will expire. Number Read only
first_name The customer's given name. String Read only
last_name The customer's surname. String Read only
email The customer's email address. Email Read only
cc_type The credit card or debit card type. String Read only
cc_number_masked A masked version of this payment card showing only the last 4 digits. String Read only
cc_exp_month The payment card expiration month in the MM format. String Read only
cc_exp_year The payment card expiration year in the YYYY format. String Read only
date_created The date this resource was created. Date Read only
date_modified The date this resource was last modified. Date Read only

Example Representation

{
        "_links": {
        "curies": [
            {
                "name": "fx",
                "href": "https://api.foxycart.com/rels/{rel}",
                "templated": true
            }
        ],
          "self": {
            "href": "https://api.foxycart.com/payment_methods_expiring/115",
            "title": "Payment Method Expiring"
          },
          "fx:store": {
            "href": "https://api.foxycart.com/stores/66",
            "title": "This Store"
          },
          "fx:customer": {
            "href": "https://api.foxycart.com/customers/115",
            "title": "This Customer"
          },
          "fx:default_billing_address": {
            "href": "https://api.foxycart.com/customers/115/default_billing_address",
            "title": "Default Billing Address for this Customer"
          },
          "fx:default_payment_method": {
            "href": "https://api.foxycart.com/customers/115/default_payment_method",
            "title": "Default Payment Method for this Customer"
          },
          "fx:subscriptions": {
            "href": "https://api.foxycart.com/stores/66/subscriptions?customer_id=115",
            "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"
      }
}

<?xml version="1.0" encoding="UTF-8"?>
<resource href="https://api.foxycart.com/payment_methods_expiring/115" rel="https://api.foxycart.com/rels/payment_method_expiring">
  <link rel="self" href="https://api.foxycart.com/payment_methods_expiring/115" title="Payment Method Expiring"/>
  <link rel="https://api.foxycart.com/rels/store" href="https://api.foxycart.com/stores/66" title="This Store"/>
  <link rel="https://api.foxycart.com/rels/customer" href="https://api.foxycart.com/customers/115" title="This Customer"/>
  <link rel="https://api.foxycart.com/rels/default_billing_address" href="https://api.foxycart.com/customers/115/default_billing_address" title="Default Billing Address for this Customer"/>
  <link rel="https://api.foxycart.com/rels/default_payment_method" href="https://api.foxycart.com/customers/115/default_payment_method" title="Default Payment Method for this Customer"/>
  <link rel="https://api.foxycart.com/rels/subscriptions" href="https://api.foxycart.com/stores/66/subscriptions?customer_id=115" title="Subscriptions for this Customer"/>
  <months_before_expiration>75</months_before_expiration>
  <first_name>Test</first_name>
  <last_name>User</last_name>
  <email>luke.stokes+apitest998@example.com</email>
  <cc_type>Visa</cc_type>
  <cc_number_masked>xxxxxxxxxxxx1111</cc_number_masked>
  <cc_exp_month>12</cc_exp_month>
  <cc_exp_year>2020</cc_exp_year>
  <date_created></date_created>
  <date_modified>2013-08-16T14:13:54-0700</date_modified>
</resource>

{
    "class": [
        "payment_method_expiring"
    ],
    "properties": {
        "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"
    },
    "links": [
        {
            "rel": [
                "self"
            ],
            "href": "https://api.foxycart.com/payment_methods_expiring/115"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/store"
            ],
            "href": "https://api.foxycart.com/stores/66"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/customer"
            ],
            "href": "https://api.foxycart.com/customers/115"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/default_billing_address"
            ],
            "href": "https://api.foxycart.com/customers/115/default_billing_address"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/default_payment_method"
            ],
            "href": "https://api.foxycart.com/customers/115/default_payment_method"
        },
        {
            "rel": [
                "https://api.foxycart.com/rels/subscriptions"
            ],
            "href": "https://api.foxycart.com/stores/66/subscriptions?customer_id=115"
        }
    ]
}

Zoomable Resources

This resource has no linked resources which can be "zoomed" in on, filtered and embedded within this resource.