Introducing our brand new Rules Engine —
Read the docs
LogoLogo
Core APIOther APIsChangelog
API reference
API reference
  • Introduction
  • Addresses
    • The address object
    • Create an address
    • List all addresses
    • Retrieve an address
    • Update an address
    • Delete an address
  • Adjustments
    • The adjustment object
    • Create an adjustment
    • List all adjustments
    • Retrieve an adjustment
    • Update an adjustment
    • Delete an adjustment
  • Adyen gateways
    • The adyen gateway object
    • Create an adyen gateway
    • List all adyen gateways
    • Retrieve an adyen gateway
    • Update an adyen gateway
    • Delete an adyen gateway
  • Adyen payments
    • The adyen payment object
    • Create an adyen payment
    • List all adyen payments
    • Retrieve an adyen payment
    • Update an adyen payment
    • Delete an adyen payment
  • Applications
    • The application object
    • Retrieve the application
  • Attachments
    • The attachment object
    • Create an attachment
    • List all attachments
    • Retrieve an attachment
    • Update an attachment
    • Delete an attachment
  • Authorizations
    • The authorization object
    • List all authorizations
    • Retrieve an authorization
    • Update an authorization
  • Avalara accounts
    • The avalara account object
    • Create an avalara account
    • List all avalara accounts
    • Retrieve an avalara account
    • Update an avalara account
    • Delete an avalara account
  • Axerve gateways
    • The axerve gateway object
    • Create an axerve gateway
    • List all axerve gateways
    • Retrieve an axerve gateway
    • Update an axerve gateway
    • Delete an axerve gateway
  • Axerve payments
    • The axerve payment object
    • Create an axerve payment
    • List all axerve payments
    • Retrieve an axerve payment
    • Update an axerve payment
    • Delete an axerve payment
  • Bing geocoders
    • The bing geocoder object
    • Create a bing geocoder
    • List all bing geocoders
    • Retrieve a bing geocoder
    • Update a bing geocoder
    • Delete a bing geocoder
  • Braintree gateways
    • The braintree gateway object
    • Create a braintree gateway
    • List all braintree gateways
    • Retrieve a braintree gateway
    • Update a braintree gateway
    • Delete a braintree gateway
  • Braintree payments
    • The braintree payment object
    • Create a braintree payment
    • List all braintree payments
    • Retrieve a braintree payment
    • Update a braintree payment
    • Delete a braintree payment
  • Bundles
    • The bundle object
    • Create a bundle
    • List all bundles
    • Retrieve a bundle
    • Update a bundle
    • Delete a bundle
  • Buy x pay y promotions
    • The buy x pay y promotion object
    • Create a buy x pay y promotion
    • List all buy x pay y promotions
    • Retrieve a buy x pay y promotion
    • Update a buy x pay y promotion
    • Delete a buy x pay y promotion
  • Captures
    • The capture object
    • List all captures
    • Retrieve a capture
    • Update a capture
  • Carrier accounts
    • The carrier account object
    • Create a carrier account
    • List all carrier accounts
    • Retrieve a carrier account
    • Update a carrier account
    • Delete a carrier account
  • Checkout.com gateways
    • The checkout.com gateway object
    • Create a checkout.com gateway
    • List all checkout.com gateways
    • Retrieve a checkout.com gateway
    • Update a checkout.com gateway
    • Delete a checkout.com gateway
  • Checkout.com payments
    • The checkout.com payment object
    • Create a checkout.com payment
    • List all checkout.com payments
    • Retrieve a checkout.com payment
    • Update a checkout.com payment
    • Delete a checkout.com payment
  • Cleanups
    • The cleanup object
    • Create a cleanup
    • List all cleanups
    • Retrieve a cleanup
    • Update a cleanup
    • Delete a cleanup
  • Coupon codes promotion rules
    • The coupon codes promotion rule object
    • Create a coupon codes promotion rule
    • List all coupon codes promotion rules
    • Retrieve a coupon codes promotion rule
    • Update a coupon codes promotion rule
    • Delete a coupon codes promotion rule
  • Coupon recipients
    • The coupon recipient object
    • Create a coupon recipient
    • List all coupon recipients
    • Retrieve a coupon recipient
    • Update a coupon recipient
    • Delete a coupon recipient
  • Coupons
    • The coupon object
    • Create a coupon
    • List all coupons
    • Retrieve a coupon
    • Update a coupon
    • Delete a coupon
  • Custom promotion rules
    • The custom promotion rule object
    • Create a custom promotion rule
    • List all custom promotion rules
    • Retrieve a custom promotion rule
    • Update a custom promotion rule
    • Delete a custom promotion rule
  • Customer addresses
    • The customer address object
    • Create a customer address
    • List all customer addresses
    • Retrieve a customer address
    • Update a customer address
    • Delete a customer address
  • Customer groups
    • The customer group object
    • Create a customer group
    • List all customer groups
    • Retrieve a customer group
    • Update a customer group
    • Delete a customer group
  • Customer password resets
    • The customer password reset object
    • Create a customer password reset
    • List all customer password resets
    • Retrieve a customer password reset
    • Update a customer password reset
    • Delete a customer password reset
  • Customer payment sources
    • The customer payment source object
    • Create a customer payment source
    • List all customer payment sources
    • Retrieve a customer payment source
    • Update a customer payment source
    • Delete a customer payment source
  • Customer subscriptions
    • The customer subscription object
    • Create a customer subscription
    • List all customer subscriptions
    • Retrieve a customer subscription
    • Update a customer subscription
    • Delete a customer subscription
  • Customers
    • The customer object
    • Create a customer
    • List all customers
    • Retrieve a customer
    • Update a customer
    • Delete a customer
  • Delivery lead times
    • The delivery lead time object
    • Create a delivery lead time
    • List all delivery lead times
    • Retrieve a delivery lead time
    • Update a delivery lead time
    • Delete a delivery lead time
  • Easypost pickups
    • The easypost pickup object
    • Create an easypost pickup
    • List all easypost pickups
    • Retrieve an easypost pickup
    • Update an easypost pickup
    • Delete an easypost pickup
  • Event callbacks
    • The event callback object
    • List all event callbacks
    • Retrieve an event callback
  • Events
    • The event object
    • List all events
    • Retrieve an event
    • Update an event
  • Exports
    • The export object
    • Create an export
    • List all exports
    • Retrieve an export
    • Update an export
    • Delete an export
  • External gateways
    • The external gateway object
    • Create an external gateway
    • List all external gateways
    • Retrieve an external gateway
    • Update an external gateway
    • Delete an external gateway
  • External payments
    • The external payment object
    • Create an external payment
    • List all external payments
    • Retrieve an external payment
    • Update an external payment
    • Delete an external payment
  • External promotions
    • The external promotion object
    • Create an external promotion
    • List all external promotions
    • Retrieve an external promotion
    • Update an external promotion
    • Delete an external promotion
  • External tax calculators
    • The external tax calculator object
    • Create an external tax calculator
    • List all external tax calculators
    • Retrieve an external tax calculator
    • Update an external tax calculator
    • Delete an external tax calculator
  • Fixed amount promotions
    • The fixed amount promotion object
    • Create a fixed amount promotion
    • List all fixed amount promotions
    • Retrieve a fixed amount promotion
    • Update a fixed amount promotion
    • Delete a fixed amount promotion
  • Fixed price promotions
    • The fixed price promotion object
    • Create a fixed price promotion
    • List all fixed price promotions
    • Retrieve a fixed price promotion
    • Update a fixed price promotion
    • Delete a fixed price promotion
  • Flex promotions
    • The flex promotion object
    • Create a flex promotion
    • List all flex promotions
    • Retrieve a flex promotion
    • Update a flex promotion
    • Delete a flex promotion
  • Free gift promotions
    • The free gift promotion object
    • Create a free gift promotion
    • List all free gift promotions
    • Retrieve a free gift promotion
    • Update a free gift promotion
    • Delete a free gift promotion
  • Free shipping promotions
    • The free shipping promotion object
    • Create a free shipping promotion
    • List all free shipping promotions
    • Retrieve a free shipping promotion
    • Update a free shipping promotion
    • Delete a free shipping promotion
  • Geocoders
    • The geocoder object
    • List all geocoders
    • Retrieve a geocoder
  • Gift card recipients
    • The gift card recipient object
    • Create a gift card recipient
    • List all gift card recipients
    • Retrieve a gift card recipient
    • Update a gift card recipient
    • Delete a gift card recipient
  • Gift cards
    • The gift card object
    • Create a gift card
    • List all gift cards
    • Retrieve a gift card
    • Update a gift card
    • Delete a gift card
  • Google geocoders
    • The google geocoder object
    • Create a google geocoder
    • List all google geocoders
    • Retrieve a google geocoder
    • Update a google geocoder
    • Delete a google geocoder
  • Imports
    • The import object
    • Create an import
    • List all imports
    • Retrieve an import
    • Update an import
    • Delete an import
  • In stock subscriptions
    • The in stock subscription object
    • Create an in stock subscription
    • List all in stock subscriptions
    • Retrieve an in stock subscription
    • Update an in stock subscription
    • Delete an in stock subscription
  • Inventory models
    • The inventory model object
    • Create an inventory model
    • List all inventory models
    • Retrieve an inventory model
    • Update an inventory model
    • Delete an inventory model
  • Inventory return locations
    • The inventory return location object
    • Create an inventory return location
    • List all inventory return locations
    • Retrieve an inventory return location
    • Update an inventory return location
    • Delete an inventory return location
  • Inventory stock locations
    • The inventory stock location object
    • Create an inventory stock location
    • List all inventory stock locations
    • Retrieve an inventory stock location
    • Update an inventory stock location
    • Delete an inventory stock location
  • Klarna gateways
    • The klarna gateway object
    • Create a klarna gateway
    • List all klarna gateways
    • Retrieve a klarna gateway
    • Update a klarna gateway
    • Delete a klarna gateway
  • Klarna payments
    • The klarna payment object
    • Create a klarna payment
    • List all klarna payments
    • Retrieve a klarna payment
    • Update a klarna payment
    • Delete a klarna payment
  • Line item options
    • The line item option object
    • Create a line item option
    • List all line item options
    • Retrieve a line item option
    • Update a line item option
    • Delete a line item option
  • Line items
    • The line item object
    • Create a line item
    • List all line items
    • Retrieve a line item
    • Update a line item
    • Delete a line item
  • Links
    • The link object
    • Create a link
    • List all links
    • Retrieve a link
    • Update a link
    • Delete a link
  • Manual gateways
    • The manual gateway object
    • Create a manual gateway
    • List all manual gateways
    • Retrieve a manual gateway
    • Update a manual gateway
    • Delete a manual gateway
  • Manual tax calculators
    • The manual tax calculator object
    • Create a manual tax calculator
    • List all manual tax calculators
    • Retrieve a manual tax calculator
    • Update a manual tax calculator
    • Delete a manual tax calculator
  • Markets
    • The market object
    • Create a market
    • List all markets
    • Retrieve a market
    • Update a market
    • Delete a market
  • Merchants
    • The merchant object
    • Create a merchant
    • List all merchants
    • Retrieve a merchant
    • Update a merchant
    • Delete a merchant
  • Notifications
    • The notification object
    • Create a notification
    • List all notifications
    • Retrieve a notification
    • Update a notification
    • Delete a notification
  • Order amount promotion rules
    • The order amount promotion rule object
    • Create an order amount promotion rule
    • List all order amount promotion rules
    • Retrieve an order amount promotion rule
    • Update an order amount promotion rule
    • Delete an order amount promotion rule
  • Order copies
    • The order copy object
    • Create an order copy
    • List all order copies
    • Retrieve an order copy
    • Update an order copy
    • Delete an order copy
  • Order factories
    • The order factory object
    • List all order factories
    • Retrieve an order factory
  • Order subscription items
    • The order subscription item object
    • Create an order subscription item
    • List all order subscription items
    • Retrieve an order subscription item
    • Update an order subscription item
    • Delete an order subscription item
  • Order subscriptions
    • The order subscription object
    • Create an order subscription
    • List all order subscriptions
    • Retrieve an order subscription
    • Update an order subscription
    • Delete an order subscription
  • Orders
    • The order object
    • Create an order
    • List all orders
    • Retrieve an order
    • Update an order
    • Delete an order
  • Organizations
    • The organization object
    • Retrieve the organization
  • Packages
    • The package object
    • Create a package
    • List all packages
    • Retrieve a package
    • Update a package
    • Delete a package
  • Parcel line items
    • The parcel line item object
    • Create a parcel line item
    • List all parcel line items
    • Retrieve a parcel line item
    • Update a parcel line item
    • Delete a parcel line item
  • Parcels
    • The parcel object
    • Create a parcel
    • List all parcels
    • Retrieve a parcel
    • Update a parcel
    • Delete a parcel
  • Payment gateways
    • The payment gateway object
    • List all payment gateways
    • Retrieve a payment gateway
  • Payment methods
    • The payment method object
    • Create a payment method
    • List all payment methods
    • Retrieve a payment method
    • Update a payment method
    • Delete a payment method
  • Payment options
    • The payment option object
    • Create a payment option
    • List all payment options
    • Retrieve a payment option
    • Update a payment option
    • Delete a payment option
  • Paypal gateways
    • The paypal gateway object
    • Create a paypal gateway
    • List all paypal gateways
    • Retrieve a paypal gateway
    • Update a paypal gateway
    • Delete a paypal gateway
  • Paypal payments
    • The paypal payment object
    • Create a paypal payment
    • List all paypal payments
    • Retrieve a paypal payment
    • Update a paypal payment
    • Delete a paypal payment
  • Percentage discount promotions
    • The percentage discount promotion object
    • Create a percentage discount promotion
    • List all percentage discount promotions
    • Retrieve a percentage discount promotion
    • Update a percentage discount promotion
    • Delete a percentage discount promotion
  • Pickups
    • The pickup object
    • List all pickups
    • Retrieve a pickup
  • Price frequency tiers
    • The price frequency tier object
    • Create a price frequency tier
    • List all price frequency tiers
    • Retrieve a price frequency tier
    • Update a price frequency tier
    • Delete a price frequency tier
  • Price list schedulers
    • The price list scheduler object
    • Create a price list scheduler
    • List all price list schedulers
    • Retrieve a price list scheduler
    • Update a price list scheduler
    • Delete a price list scheduler
  • Price lists
    • The price list object
    • Create a price list
    • List all price lists
    • Retrieve a price list
    • Update a price list
    • Delete a price list
  • Price tiers
    • The price tier object
    • List all price tiers
    • Retrieve a price tier
  • Price volume tiers
    • The price volume tier object
    • Create a price volume tier
    • List all price volume tiers
    • Retrieve a price volume tier
    • Update a price volume tier
    • Delete a price volume tier
  • Prices
    • The price object
    • Create a price
    • List all prices
    • Retrieve a price
    • Update a price
    • Delete a price
  • Promotion rules
    • The promotion rule object
    • List all promotion rules
    • Retrieve a promotion rule
  • Promotions
    • The promotion object
    • List all promotions
    • Retrieve a promotion
  • Recurring order copies
    • The recurring order copy object
    • Create a recurring order copy
    • List all recurring order copies
    • Retrieve a recurring order copy
    • Update a recurring order copy
    • Delete a recurring order copy
  • Refunds
    • The refund object
    • List all refunds
    • Retrieve a refund
    • Update a refund
  • Reserved stocks
    • The reserved stock object
    • List all reserved stocks
    • Retrieve a reserved stock
  • Resource errors
    • The resource error object
    • List all resource errors
    • Retrieve a resource error
  • Return line items
    • The return line item object
    • Create a return line item
    • List all return line items
    • Retrieve a return line item
    • Update a return line item
    • Delete a return line item
  • Returns
    • The return object
    • Create a return
    • List all returns
    • Retrieve a return
    • Update a return
    • Delete a return
  • Satispay gateways
    • The satispay gateway object
    • Create a satispay gateway
    • List all satispay gateways
    • Retrieve a satispay gateway
    • Update a satispay gateway
    • Delete a satispay gateway
  • Satispay payments
    • The satispay payment object
    • Create a satispay payment
    • List all satispay payments
    • Retrieve a satispay payment
    • Update a satispay payment
    • Delete a satispay payment
  • Shipments
    • The shipment object
    • Create a shipment
    • List all shipments
    • Retrieve a shipment
    • Update a shipment
    • Delete a shipment
  • Shipping categories
    • The shipping category object
    • Create a shipping category
    • List all shipping categories
    • Retrieve a shipping category
    • Update a shipping category
    • Delete a shipping category
  • Shipping method tiers
    • The shipping method tier object
    • List all shipping method tiers
    • Retrieve a shipping method tier
  • Shipping methods
    • The shipping method object
    • Create a shipping method
    • List all shipping methods
    • Retrieve a shipping method
    • Update a shipping method
    • Delete a shipping method
  • Shipping weight tiers
    • The shipping weight tier object
    • Create a shipping weight tier
    • List all shipping weight tiers
    • Retrieve a shipping weight tier
    • Update a shipping weight tier
    • Delete a shipping weight tier
  • Shipping zones
    • The shipping zone object
    • Create a shipping zone
    • List all shipping zones
    • Retrieve a shipping zone
    • Update a shipping zone
    • Delete a shipping zone
  • SKU list items
    • The SKU list item object
    • Create a SKU list item
    • List all SKU list items
    • Retrieve a SKU list item
    • Update a SKU list item
    • Delete a SKU list item
  • SKU list promotion rules
    • The SKU list promotion rule object
    • Create a SKU list promotion rule
    • List all SKU list promotion rules
    • Retrieve a SKU list promotion rule
    • Update a SKU list promotion rule
    • Delete a SKU list promotion rule
  • SKU lists
    • The SKU list object
    • Create a SKU list
    • List all SKU lists
    • Retrieve a SKU list
    • Update a SKU list
    • Delete a SKU list
  • SKU options
    • The SKU option object
    • Create a SKU option
    • List all SKU options
    • Retrieve a SKU option
    • Update a SKU option
    • Delete a SKU option
  • SKUs
    • The SKU object
    • Create a SKU
    • List all SKUs
    • Retrieve a SKU
    • Update a SKU
    • Delete a SKU
  • Stock items
    • The stock item object
    • Create a stock item
    • List all stock items
    • Retrieve a stock item
    • Update a stock item
    • Delete a stock item
  • Stock line items
    • The stock line item object
    • Create a stock line item
    • List all stock line items
    • Retrieve a stock line item
    • Update a stock line item
    • Delete a stock line item
  • Stock locations
    • The stock location object
    • Create a stock location
    • List all stock locations
    • Retrieve a stock location
    • Update a stock location
    • Delete a stock location
  • Stock reservations
    • The stock reservation object
    • Create a stock reservation
    • List all stock reservations
    • Retrieve a stock reservation
    • Update a stock reservation
    • Delete a stock reservation
  • Stock transfers
    • The stock transfer object
    • Create a stock transfer
    • List all stock transfers
    • Retrieve a stock transfer
    • Update a stock transfer
    • Delete a stock transfer
  • Stores
    • The store object
    • Create a store
    • List all stores
    • Retrieve a store
    • Update a store
    • Delete a store
  • Stripe gateways
    • The stripe gateway object
    • Create a stripe gateway
    • List all stripe gateways
    • Retrieve a stripe gateway
    • Update a stripe gateway
    • Delete a stripe gateway
  • Stripe payments
    • The stripe payment object
    • Create a stripe payment
    • List all stripe payments
    • Retrieve a stripe payment
    • Update a stripe payment
    • Delete a stripe payment
  • Stripe tax accounts
    • The stripe tax account object
    • Create a stripe tax account
    • List all stripe tax accounts
    • Retrieve a stripe tax account
    • Update a stripe tax account
    • Delete a stripe tax account
  • Subscription models
    • The subscription model object
    • Create a subscription model
    • List all subscription models
    • Retrieve a subscription model
    • Update a subscription model
    • Delete a subscription model
  • Tags
    • The tag object
    • Create a tag
    • List all tags
    • Retrieve a tag
    • Update a tag
    • Delete a tag
  • Tax calculators
    • The tax calculator object
    • List all tax calculators
    • Retrieve a tax calculator
  • Tax categories
    • The tax category object
    • Create a tax category
    • List all tax categories
    • Retrieve a tax category
    • Update a tax category
    • Delete a tax category
  • Tax rules
    • The tax rule object
    • Create a tax rule
    • List all tax rules
    • Retrieve a tax rule
    • Update a tax rule
    • Delete a tax rule
  • Taxjar accounts
    • The taxjar account object
    • Create a taxjar account
    • List all taxjar accounts
    • Retrieve a taxjar account
    • Update a taxjar account
    • Delete a taxjar account
  • Transactions
    • The transaction object
    • List all transactions
    • Retrieve a transaction
  • Versions
    • The version object
    • List all versions
    • Retrieve a version
  • Vertex accounts
    • The vertex account object
    • Create a vertex account
    • List all vertex accounts
    • Retrieve a vertex account
    • Update a vertex account
    • Delete a vertex account
  • Voids
    • The void object
    • List all voids
    • Retrieve a void
    • Update a void
  • Webhooks
    • The webhook object
    • Create a webhook
    • List all webhooks
    • Retrieve a webhook
    • Update a webhook
    • Delete a webhook
  • Wire transfers
    • The wire transfer object
    • Create a wire transfer
    • List all wire transfers
    • Retrieve a wire transfer
    • Update a wire transfer
    • Delete a wire transfer
On this page
  1. Payment methods

The payment method object

A comprehensive list of the payment method resource's attributes and relationships

A payment method object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/payment_methods endpoint.

Fields

Field
Type
Description

type

string

payment_methods

id

string

The payment method unique identifier

links.self

string

The payment method endpoint URL

attributes.name

string

The payment method's internal name.

attributes.payment_source_type

string

The payment source type. One of 'adyen_payments', 'axerve_payments', 'braintree_payments', 'checkout_com_payments', 'credit_cards', 'external_payments', 'klarna_payments', 'paypal_payments', 'satispay_payments', 'stripe_payments', or 'wire_transfers'.

attributes.currency_code

string

The international 3-letter currency code as defined by the ISO 4217 standard.

attributes.moto

boolean

Send this attribute if you want to mark the payment as MOTO, must be supported by payment gateway.

attributes.require_capture

boolean

Send this attribute if you want to require the payment capture before fulfillment.

attributes.auto_place

boolean

Send this attribute if you want to automatically place the order upon authorization performed asynchronously.

attributes.auto_capture

boolean

Send this attribute if you want to automatically capture the payment upon authorization.

attributes.price_amount_cents

integer

The payment method's price, in cents.

attributes.price_amount_float

float

The payment method's price, float.

attributes.formatted_price_amount

string

The payment method's price, formatted.

attributes.auto_capture_max_amount_cents

integer

Send this attribute if you want to limit automatic capture to orders for which the total amount is equal or less than the specified value, in cents.

attributes.auto_capture_max_amount_float

float

The automatic capture max amount, float.

attributes.formatted_auto_capture_max_amount

string

The automatic capture max amount, formatted.

attributes._disable

boolean

Send this attribute if you want to mark this resource as disabled.

attributes._enable

boolean

Send this attribute if you want to mark this resource as enabled.

attributes.disabled_at

datetime

Time at which this resource was disabled.

attributes.created_at

datetime

Time at which the resource was created.

attributes.updated_at

datetime

Time at which the resource was last updated.

attributes.reference

string

A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.

attributes.reference_origin

string

Any identifier of the third party system that defines the reference code.

attributes.metadata

object

Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.

relationships.market

object

The associated market.

relationships.payment_gateway

object

The associated payment gateway.

relationships.store

object

The associated store.

relationships.attachments

array

The associated attachments.

relationships.versions

array

The associated changes.

meta.mode

string

The resource environment (can be one of test or live)

PreviousPayment methodsNextCreate a payment method

Last updated 29 days ago