payment_methods_expiring

Resource: payment_method_expiring

This link relationship returns a collection of payment methods expiring. You can paginate through this collection using the hypermedia links provided and the link relationships of first, prev, next, and last.

Required Scopes

Full store_full_access
Read reporting_read
Write reporting_write

Collection Resource

payment_method_expiring

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

Properties (5)

_embedded Object · Read-only

Contains fx:payment_methods_expiring[] — array of payment_method_expiring resources

total_items String · Read-only

Total number of resources in this collection.

returned_items Number · Read-only

Number of resources returned in this page.

limit Number · Read-only

Maximum number of resources per page.

offset Number · Read-only

Number of resources skipped.

Link Relations (5)

self This Collection
first First Page of this Collection
prev Previous Page of this Collection
next Next Page of this Collection
last Last Page of this Collection
https://api.foxycart.com/stores/{store_id}/payment_methods_expiring
Available via fx:payment_methods_expiring on store

Example Representation

{
  "_links": {
    "curies": [
      {
        "name": "fx",
        "href": "https://api.foxycart.com/rels/{rel}",
        "templated": true
      }
    ],
    "self": {
      "href": "https://api.foxycart.com/stores/123/payment_methods_expiring",
      "title": "This Collection"
    },
    "first": {
      "href": "https://api.foxycart.com/stores/123/payment_methods_expiring?offset=0",
      "title": "First Page of this Collection"
    },
    "prev": {
      "href": "https://api.foxycart.com/stores/123/payment_methods_expiring?offset=0",
      "title": "Previous Page of this Collection"
    },
    "next": {
      "href": "https://api.foxycart.com/stores/123/payment_methods_expiring?offset=20",
      "title": "Next Page of this Collection"
    },
    "last": {
      "href": "https://api.foxycart.com/stores/123/payment_methods_expiring?offset=20",
      "title": "Last Page of this Collection"
    }
  },
  "_embedded": {
    "fx:payment_methods_expiring": [
      {
        "_links": {
          "curies": [
            {
              "name": "fx",
              "href": "https://api.foxycart.com/rels/{rel}",
              "templated": true
            }
          ],
          "self": {
            "href": "https://api.foxycart.com/payment_methods_expiring/456",
            "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"
      }
    ]
  },
  "total_items": 1,
  "returned_items": 1,
  "limit": 20,
  "offset": 0
}