Important update: Changes to orders API billing information

What's changing?

Previously, the Orders API has provided basic billing information as part of retrieved orders. However, this information is no longer necessary to merchants using the Orders API. For that reason, we will stop providing the following fields in Order resources returned by Orders.get and Orders.list:

  • paymentMethod.type
  • paymentMethod.lastFourDigits
  • paymentMethod.expirationMonth
  • paymentMethod.expirationYear
  • paymentMethod.phoneNumber

Because there may be code that assumes these fields will still be populated, there will be two phases to this process:

On September 15, 2018, the Content API will begin to only contain dummy information for these fields. These fields will contain values, as shown below, that match the types expected of previously valid values:

"paymentMethod" : {
  "type" : "",
  "lastFourDigits" : "1234",
  "expirationMonth" : 1,
  "expirationYear" : 1990,
  "phoneNumber" : "1-111-111-1111",
  ...
}

Note: The values used above are illustrative and may change, so you should not use these specific values to decide if a response has valid paymentMethod information.

These dummy values ensure the response can be decoded and used without type errors by code that assumes this information is available, but that customer information not needed by the merchant has been appropriately redacted.

On November 15, 2018, the Content API will no longer provide these fields in Order resources. Any code that assumes that these fields exist may fail when decoding Order resources, so you should no longer use these fields by this date.

What do I need to do?

You should alter any solutions using the Orders API so that they no longer depend on the contents of the fields listed above. On September 15, 2018, you’ll stop receiving valid information in these fields, and If you have not removed uses of these fields by November 15, 2018, your solutions may fail at runtime.

Was this helpful?
How can we improve it?

Need more help?

Sign in for additional support options to quickly solve your issue