Stripe (version v2.*.*)

intent (required)#

Type: string

$body#

Type: object

{
  "expand" : [ "string" ]
}

payout (required)#

The identifier of the payout to be canceled.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ]
}

topup (required)#

The ID of the top-up to cancel.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ]
}

charge (required)#

Type: string

$body#

Type: object

{
  "statement_descriptor" : "An arbitrary string to be displayed on your customer's credit card statement. This may be up to *22 characters*. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket`. The statement description must contain at least one letter, may not include `<>\"'` characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. Updating this value will overwrite the previous statement descriptor of this charge. While most banks display this information consistently, some may display it incorrectly or not at all.",
  "amount" : "The amount to capture, which must be less than or equal to the original amount. Any additional amount will be automatically refunded.",
  "expand" : [ "string" ],
  "transfer_group" : "A string that identifies this transaction as part of a group. `transfer_group` may only be provided if it has not been set. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) for details.",
  "receipt_email" : "The email address to send this charge's receipt to. This will override the previously-specified email address for this charge, if one was set. Receipts will not be sent in test mode.",
  "destination" : {
    "amount" : "integer"
  },
  "application_fee" : "An application fee to add on to this charge. Can only be used with Stripe Connect."
}

dispute (required)#

ID of the dispute to close.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ]
}

$body#

Type: object

{
  "business_logo" : "(ID of a [file upload](https://stripe.com/docs/guides/file-upload)) A logo for this account (at least 128px x 128px)",
  "debit_negative_balances" : "A Boolean indicating whether Stripe should try to reclaim negative balances from an attached bank account. For details, see [Understanding Connect Account Balances](/docs/connect/account-balances).",
  "tos_acceptance" : {
    "date" : "Required integer",
    "ip" : "Required string",
    "user_agent" : "string"
  },
  "country" : "The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created.",
  "metadata" : { },
  "from_recipient" : "string",
  "payout_schedule" : {
    "weekly_anchor" : "string. Possible values: friday | monday | saturday | sunday | thursday | tuesday | wednesday",
    "interval" : "string. Possible values: daily | four_times_monthly | manual | monthly | weekly",
    "delay_days" : "integer",
    "monthly_anchor" : "integer"
  },
  "support_phone" : "A publicly shareable support phone number for the business.",
  "account_token" : "An [account token](https://stripe.com/docs/api#create_account_token), used to securely provide details to the account.",
  "type" : "Whether you'd like to create a [Standard or Custom](/docs/connect/accounts) account. Standard accounts are normal Stripe accounts: Stripe will email the account holder to set up a username and password, and will handle all account management directly with them. Custom accounts have extra parameters available to them, and require that you, the platform, handle all communication with the account holder. Possible values are `standard` and `custom`.",
  "statement_descriptor" : "The default text that appears on credit card statements when a charge is made [directly on the account](/docs/connect/direct-charges)",
  "support_url" : "A publicly shareable URL that provides support for this account.",
  "legal_entity" : {
    "business_vat_id" : "string",
    "personal_address_kana" : {
      "country" : "string",
      "town" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "gender" : "string",
    "address_kana" : {
      "country" : "string",
      "town" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "type" : "string",
    "personal_address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "address_kanji" : {
      "country" : "string",
      "town" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "ssn_last_4" : "string",
    "first_name" : "string",
    "first_name_kana" : "string",
    "personal_id_number" : "string",
    "verification" : {
      "document" : "string"
    },
    "last_name_kanji" : "string",
    "personal_address_kanji" : {
      "country" : "string",
      "town" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "business_name" : "string",
    "maiden_name" : "string",
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "business_tax_id" : "string",
    "first_name_kanji" : "string",
    "last_name" : "string",
    "business_name_kana" : "string",
    "tax_id_registrar" : "string",
    "dob" : {
      "month" : "Required integer",
      "year" : "Required integer",
      "day" : "Required integer"
    },
    "additional_owners" : {
      "<string>" : {
        "maiden_name" : "string",
        "address" : {
          "country" : "string",
          "city" : "string",
          "state" : "string",
          "postal_code" : "string",
          "line2" : "string",
          "line1" : "string"
        },
        "dob" : {
          "month" : "Required integer",
          "year" : "Required integer",
          "day" : "Required integer"
        },
        "last_name" : "string",
        "first_name" : "string",
        "personal_id_number" : "string",
        "verification" : {
          "document" : "string"
        }
      }
    },
    "last_name_kana" : "string",
    "business_name_kanji" : "string",
    "phone_number" : "string"
  },
  "business_url" : "The URL that best shows the service or product provided by this account.",
  "product_description" : "Internal-only description of the product sold by, or service provided by, the business. Used by Stripe for risk and underwriting purposes.",
  "email" : "The email address of the account holder. For Standard accounts, Stripe will email your user with instructions on how to set up their account. For Custom accounts, this is only to make the account easier to identify to you: Stripe will never directly email your users.",
  "bank_account" : { },
  "business_name" : "The publicly sharable name for this account.",
  "decline_charge_on" : {
    "avs_failure" : "boolean",
    "cvc_failure" : "boolean"
  },
  "expand" : [ "string" ],
  "support_email" : "A publicly shareable support email address for the business.",
  "external_account" : { },
  "business_primary_color" : "A CSS hex color value representing the primary branding color for this account.",
  "default_currency" : "Three-letter ISO currency code representing the default currency for the account. This must be a currency that [Stripe supports in the account's country](https://stripe.com/docs/payouts).",
  "payout_statement_descriptor" : "The text that appears on the bank account statement for payouts. If not set, this defaults to the platform's bank descriptor as set in the Dashboard."
}

account (required)#

Type: string

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "external_account" : { },
  "default_for_currency" : "When set to true, or if this is the first external account added in this currency, this account becomes the default external account for its currency.",
  "bank_account" : { }
}

$body#

Type: object

{
  "amount" : "integer",
  "payment_user_agent" : "string",
  "ip" : "string",
  "external_id" : "string",
  "pii" : {
    "ssn_last_4" : "string",
    "personal_id_number" : "string",
    "tax_id" : "string"
  },
  "referrer" : "string",
  "validation_type" : "string. Possible values: amount | card | none",
  "expand" : [ "string" ],
  "iovation_blackbox" : "string",
  "recipient" : "string",
  "currency" : "string",
  "request_id" : "string",
  "account" : {
    "tos_shown_and_accepted" : "boolean",
    "legal_entity" : {
      "business_vat_id" : "string",
      "personal_address_kana" : {
        "country" : "string",
        "town" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "gender" : "string",
      "address_kana" : {
        "country" : "string",
        "town" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "type" : "string",
      "personal_address" : {
        "country" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "address_kanji" : {
        "country" : "string",
        "town" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "ssn_last_4" : "string",
      "first_name" : "string",
      "first_name_kana" : "string",
      "personal_id_number" : "string",
      "verification" : {
        "document" : "string"
      },
      "last_name_kanji" : "string",
      "personal_address_kanji" : {
        "country" : "string",
        "town" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "business_name" : "string",
      "maiden_name" : "string",
      "address" : {
        "country" : "string",
        "city" : "string",
        "state" : "string",
        "postal_code" : "string",
        "line2" : "string",
        "line1" : "string"
      },
      "business_tax_id" : "string",
      "first_name_kanji" : "string",
      "last_name" : "string",
      "business_name_kana" : "string",
      "tax_id_registrar" : "string",
      "dob" : {
        "month" : "Required integer",
        "year" : "Required integer",
        "day" : "Required integer"
      },
      "additional_owners" : {
        "<string>" : {
          "maiden_name" : "string",
          "address" : {
            "country" : "string",
            "city" : "string",
            "state" : "string",
            "postal_code" : "string",
            "line2" : "string",
            "line1" : "string"
          },
          "dob" : {
            "month" : "Required integer",
            "year" : "Required integer",
            "day" : "Required integer"
          },
          "last_name" : "string",
          "first_name" : "string",
          "personal_id_number" : "string",
          "verification" : {
            "document" : "string"
          }
        }
      },
      "last_name_kana" : "string",
      "business_name_kanji" : "string",
      "phone_number" : "string"
    }
  },
  "card" : {
    "token_cryptogram_currency" : "string",
    "pk_token" : "string",
    "token_cryptogram" : "string",
    "token_cryptogram_requestor" : "string",
    "address_country" : "string",
    "token_cryptogram_used" : "boolean",
    "address_state" : "string",
    "address_city" : "string",
    "address_line2" : "string",
    "address_line1" : "string",
    "token_cryptogram_amount" : "integer",
    "name" : "string",
    "address_zip" : "string",
    "object" : "string. Possible values: card"
  },
  "email" : "string",
  "user_agent" : "string",
  "bank_account" : { },
  "customer" : "The customer (owned by the application's account) for which to create a token. For use only with [Stripe Connect](/docs/connect). Also, this can be used only with an [OAuth access token](/docs/connect/standard-accounts) or [Stripe-Account header](/docs/connect/authentication). For more details, see [Shared Customers](/docs/connect/shared-customers)."
}

$body#

Type: object

{
  "metadata" : { },
  "destination" : {
    "amount" : "integer",
    "account" : "Required string"
  },
  "description" : "An arbitrary string which you can attach to a `Charge` object. It is displayed when in the web interface alongside the charge. Note that if you use Stripe to send automatic email receipts to your customers, your receipt emails will include the `description` of the charge(s) that they are describing.",
  "external_id" : "string",
  "source" : { },
  "invoice_source" : "string",
  "statement_descriptor" : { },
  "shipping" : {
    "carrier" : "string",
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "phone" : "string",
    "name" : "Required string",
    "tracking_number" : "string"
  },
  "alternate_statement_descriptors" : {
    "kanji" : "string",
    "kana" : "string"
  },
  "idempotency_key" : "string",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "payment_method" : "string",
  "user_agent" : "string",
  "order" : "string",
  "include" : [ "string" ],
  "amount" : "A positive integer representing how much to charge, in the [smallest currency unit](/docs/currencies#zero-decimal) (e.g., `100` cents to charge $1.00, or `100` to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 USD or [equivalent in charge currency](/docs/currencies#minimum-and-maximum-charge-amounts).",
  "payment_user_agent" : "string",
  "transfer_group" : "A string that identifies this transaction as part of a group. For details, see [Grouping transactions](/docs/connect/charges-transfers#grouping-transactions).",
  "device_id" : "string",
  "exchange_rate" : "number",
  "on_behalf_of" : "The Stripe account ID for which these funds are intended. Automatically set if you use the `destination` parameter. For details, see [Creating Separate Charges and Transfers](/docs/connect/charges-transfers#on-behalf-of).",
  "recurring" : "boolean",
  "ip" : "string",
  "cross_border_classification" : "string. Possible values: export",
  "capture" : "Whether to immediately capture the charge. When `false`, the charge issues an authorization (or pre-authorization), and will need to be [captured](#capture_charge) later. Uncaptured charges expire in _seven days_. For more information, see the [authorizing charges and settling later](/docs/charges#auth-and-capture) documentation.",
  "referrer" : "string",
  "expand" : [ "string" ],
  "application" : "string",
  "receipt_email" : "The email address to which this charge's [receipt](/docs/dashboard/receipts) will be sent. The receipt will not be sent until the charge is paid, and no receipts will be sent for test mode charges. If this charge is for a customer, the email address specified here will override the customer's email address. If `receipt_email` is specified for a charge in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.stripe.com/account/emails).",
  "statement_address" : {
    "city" : "Required string",
    "state" : "Required string",
    "postal_code" : "Required string",
    "line2" : "string",
    "line1" : "Required string"
  },
  "uncaptured" : "boolean",
  "application_fee" : "A fee in %s that will be applied to the charge and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the `Stripe-Account` header in order to take an application fee. For more information, see the application fees [documentation](/docs/connect/direct-charges#collecting-fees).",
  "invoice" : "string",
  "card_program" : "string",
  "card" : { },
  "level3" : {
    "shipping_amount" : "integer",
    "merchant_reference" : "Required string",
    "customer_reference" : "string",
    "shipping_address_zip" : "string",
    "line_items" : [ {
      "tax_amount" : "integer",
      "quantity" : "integer",
      "discount_amount" : "integer",
      "unit_cost" : "integer",
      "product_code" : "Required string",
      "product_description" : "Required string"
    } ],
    "shipping_from_zip" : "string"
  },
  "customer" : "The ID of an existing customer that will be charged in this request."
}

$body#

Type: object

{
  "duration" : "Specifies how long the discount will be in effect. Can be `forever`, `once`, or `repeating`.",
  "duration_in_months" : "Required only if `duration` is `repeating`, in which case it must be a positive integer that specifies the number of months the discount will be in effect.",
  "redeem_by" : "Unix timestamp specifying the last time at which the coupon can be redeemed. After the redeem_by date, the coupon can no longer be applied to new customers.",
  "expand" : [ "string" ],
  "metadata" : { },
  "max_redemptions" : "A positive integer specifying the number of times the coupon can be redeemed before it's no longer valid. For example, you might have a 50% off coupon that the first 20 readers of your blog can use.",
  "name" : "Name of the coupon displayed to customers on, for instance invoices, or receipts. By default the `id` is shown if `name` is not set.",
  "currency" : "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) of the `amount_off` parameter (required if `amount_off` is passed).",
  "percent_off" : "A positive float larger than 0, and smaller or equal to 100, that represents the discount the coupon will apply (required if `amount_off` is not passed).",
  "id" : "Unique string of your choice that will be used to identify this coupon when applying it to a customer. This is often a specific code you'll give to your customer to use when signing up (e.g., `FALL25OFF`). If you don't want to specify a particular code, you can leave the ID blank and we'll generate a random code for you.",
  "amount_off" : "A positive integer representing the amount to subtract from an invoice total (required if `percent_off` is not passed)."
}

$body#

Type: object

{
  "metadata" : { },
  "account_balance" : "An integer amount in %s that represents the account balance for your customer. Account balances only affect invoices. A negative amount represents a credit that decreases the amount due on an invoice; a positive amount increases the amount due on an invoice.",
  "coupon" : "string",
  "default_source" : "ID of the source to make the customer's new default.",
  "invoice_prefix" : "The prefix for the customer used to generate unique invoice numbers. Must be 3–12 uppercase letters or numbers.",
  "description" : "An arbitrary string that you can attach to a customer object. It is displayed alongside the customer in the dashboard.",
  "source" : { },
  "expand" : [ "string" ],
  "shipping" : {
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "phone" : "string",
    "name" : "Required string"
  },
  "tax_info" : {
    "type" : "Required string. Possible values: vat",
    "tax_id" : "Required string"
  },
  "id" : "A custom ID to use for the customer",
  "email" : "Customer's email address. It's displayed alongside the customer in your dashboard and can be useful for searching and tracking. This may be up to *512 characters*.",
  "customer" : "string"
}

customer (required)#

Type: string

$body#

Type: object

{
  "alipay_account" : { },
  "expand" : [ "string" ],
  "metadata" : { },
  "source" : { },
  "card" : { },
  "bank_account" : { }
}

customer (required)#

The identifier of the customer to subscribe.

Type: string

$body#

Type: object

{
  "metadata" : { },
  "cancel_at_period_end" : "Boolean indicating whether this subscription should cancel at the end of the current period.",
  "coupon" : "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.",
  "days_until_due" : "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `billing` is set to `send_invoice`.",
  "trial_end" : "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately.",
  "trial_period_days" : "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.",
  "application_fee_percent" : "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made with an OAuth key in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
  "billing_cycle_anchor" : "A future timestamp to anchor the subscription's [billing cycle](/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.",
  "billing" : "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`.",
  "tax_percent" : "A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string.",
  "expand" : [ "string" ],
  "trial_from_plan" : "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.",
  "items" : [ {
    "quantity" : "integer",
    "plan" : "Required string"
  } ],
  "prorate" : "Boolean (defaults to `true`) telling us whether to [credit for unused time](/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial). If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "expires_at" : "A future timestamp after which the link will no longer be usable.",
  "file" : "The ID of the file."
}

$body#

Type: object

{
  "statement_descriptor" : "Extra information about a charge for the customer's credit card statement. It must contain at least one letter. If not specified and this invoice is part of a subscription, the default `statement_descriptor` will be set to the first subscription item's product's `statement_descriptor`.",
  "tax_percent" : "The percent tax rate applied to the invoice, represented as a decimal number.",
  "expand" : [ "string" ],
  "metadata" : { },
  "due_date" : "The date on which payment for this invoice is due. Only valid for invoices where `billing=send_invoice`.",
  "days_until_due" : "The number of days from which the invoice is created until it is due. Only valid for invoices where `billing=send_invoice`.",
  "description" : "string",
  "application_fee" : "A fee in %s that will be applied to the invoice and transferred to the application owner's Stripe account. The request must be made with an OAuth key or the Stripe-Account header in order to take an application fee. For more information, see the application fees [documentation](/docs/connect/subscriptions#working-with-invoices).",
  "subscription" : "The ID of the subscription to invoice. If not set, the created invoice will include all pending invoice items for the customer. If set, the created invoice will exclude pending invoice items that pertain to other subscriptions.",
  "billing" : "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, Stripe will email this invoice to the customer with payment instructions. Defaults to `charge_automatically`.",
  "customer" : "Required string"
}

$body#

Type: object

{
  "amount" : "The integer amount in **%s** of the charge to be applied to the upcoming invoice. If you want to apply a credit to the customer's account, pass a negative amount.",
  "expand" : [ "string" ],
  "metadata" : { },
  "quantity" : "Non-negative integer. The quantity of units for the invoice item.",
  "description" : "An arbitrary string which you can attach to the invoice item. The description is displayed in the invoice for easy tracking.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "invoice" : "The ID of an existing invoice to add this invoice item to. When left blank, the invoice item will be added to the next upcoming scheduled invoice. Use this when adding invoice items in response to an invoice.created webhook. You cannot add an invoice item to an invoice that has already been paid, attempted or closed.",
  "subscription" : "The ID of a subscription to add this invoice item to. When left blank, the invoice item will be be added to the next upcoming scheduled invoice. When set, scheduled invoices for subscriptions other than the specified subscription will ignore the invoice item. Use this when you want to express that an invoice item has been accrued within the context of a particular subscription.",
  "unit_amount" : "The integer unit amount in **%s** of the charge to be applied to the upcoming invoice. This unit_amount will be multiplied by the quantity to get the full amount. If you want to apply a credit to the customer's account, pass a negative unit_amount.",
  "discountable" : "Controls whether discounts apply to this invoice item. Defaults to false for prorations or negative invoice items, and true for all other invoice items.",
  "customer" : "The ID of the customer who will be billed when this invoice item is billed."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "shipping" : {
    "address" : {
      "country" : "Required string",
      "city" : "Required string",
      "state" : "string",
      "postal_code" : "Required string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "name" : "Required string"
  },
  "currency" : "The currency for the card. This currently must be `usd`.",
  "cardholder" : "The [Cardholder](/docs/api#issuing_cardholder_object) object with which the card will be associated.",
  "type" : "The type of card to issue. Possible values are `physical` or `virtual`.",
  "authorization_controls" : {
    "max_approvals" : "integer",
    "allowed_categories" : [ "string. Possible values: ac_refrigeration_repair | accounting_bookkeeping_services | advertising_services | agricultural_cooperative | airlines_air_carriers | airports_flying_fields | ambulance_services | amusement_parks_carnivals | antique_reproductions | antique_shops | aquariums | architectural_surveying_services | art_dealers_and_galleries | artists_supply_and_craft_shops | auto_and_home_supply_stores | auto_body_repair_shops | auto_paint_shops | auto_service_shops | automated_cash_disburse | automated_fuel_dispensers | automobile_associations | automotive_parts_and_accessories_stores | automotive_tire_stores | bail_and_bond_payments | bakeries | bands_orchestras | barber_and_beauty_shops | betting_casino_gambling | bicycle_shops | billiard_pool_establishments | boat_dealers | boat_rentals_and_leases | book_stores | books_periodicals_and_newspapers | bowling_alleys | bus_lines | business_secretarial_schools | buying_shopping_services | cable_satellite_and_other_pay_television_and_radio | camera_and_photographic_supply_stores | candy_nut_and_confectionery_stores | car_and_truck_dealers_new_used | car_and_truck_dealers_used_only | car_rental_agencies | car_washes | carpentry_services | carpet_upholstery_cleaning | caterers | charitable_and_social_service_organizations_fundraising | chemicals_and_allied_products | chidrens_and_infants_wear_stores | child_care_services | chiropodists_podiatrists | chiropractors | cigar_stores_and_stands | civic_social_fraternal_associations | cleaning_and_maintenance | clothing_rental | colleges_universities | commercial_equipment | commercial_footwear | commercial_photography_art_and_graphics | commuter_transport_and_ferries | computer_network_services | computer_programming | computer_repair | computer_software_stores | computers_peripherals_and_software | concrete_work_services | construction_materials | consulting_public_relations | correspondence_schools | cosmetic_stores | counseling_services | country_clubs | courier_services | court_costs | credit_reporting_agencies | cruise_lines | dairy_products_stores | dance_hall_studios_schools | dating_escort_services | dentists_orthodontists | department_stores | detective_agencies | direct_marketing_catalog_merchant | direct_marketing_combination_catalog_and_retail_merchant | direct_marketing_inbound_telemarketing | direct_marketing_insurance_services | direct_marketing_other | direct_marketing_outbound_telemarketing | direct_marketing_subscription | direct_marketing_travel | discount_stores | doctors | door_to_door_sales | drapery_window_covering_and_upholstery_stores | drinking_places | drug_stores_and_pharmacies | drugs_drug_proprietaries_and_druggist_sundries | dry_cleaners | durable_goods | duty_free_stores | eating_places_restaurants | educational_services | electric_razor_stores | electrical_parts_and_equipment | electrical_services | electronics_repair_shops | electronics_stores | elementary_secondary_schools | employment_temp_agencies | equipment_rental | exterminating_services | family_clothing_stores | fast_food_restaurants | financial_institutions | fines_government_administrative_entities | fireplace_fireplace_screens_and_accessories_stores | floor_covering_stores | florists | florists_supplies_nursery_stock_and_flowers | freezer_and_locker_meat_provisioners | fuel_dealers_non_automotive | funeral_services_crematories | furniture_home_furnishings_and_equipment_stores_except_appliances | furniture_repair_refinishing | furriers_and_fur_shops | general_services | gift_card_novelty_and_souvenir_shops | glass_paint_and_wallpaper_stores | glassware_crystal_stores | golf_courses_public | government_services | grocery_stores_supermarkets | hardware_equipment_and_supplies | hardware_stores | health_and_beauty_spas | hearing_aids_sales_and_supplies | heating_plumbing_a_c | hobby_toy_and_game_shops | home_supply_warehouse_stores | hospitals | hotels_motels_and_resorts | household_appliance_stores | industrial_supplies | information_retrieval_services | insurance_default | insurance_underwriting_premiums | intra_company_purchases | jewelry_stores_watches_clocks_and_silverware_stores | landscaping_services | laundries | laundry_cleaning_services | legal_services_attorneys | luggage_and_leather_goods_stores | lumber_building_materials_stores | manual_cash_disburse | marinas_service_and_supplies | masonry_stonework_and_plaster | massage_parlors | means_womens_clothing_stores | medical_and_dental_labs | medical_dental_ophthalmic_and_hospital_equipment_and_supplies | medical_services | membership_organizations | mens_and_boys_clothing_and_accessories_stores | metal_service_centers | miscellaneous | miscellaneous_apparel_and_accessory_shops | miscellaneous_auto_dealers | miscellaneous_business_services | miscellaneous_food_stores | miscellaneous_general_merchandise | miscellaneous_general_services | miscellaneous_home_furnishing_specialty_stores | miscellaneous_publishing_and_printing | miscellaneous_recreation_services | miscellaneous_repair_shops | miscellaneous_specialty_retail | mobile_home_dealers | motion_picture_theaters | motor_freight_carriers_and_trucking | motor_homes_dealers | motor_vehicle_supplies_and_new_parts | motorcycle_shops_and_dealers | motorcycle_shops_dealers | music_stores_musical_instruments_pianos_and_sheet_music | news_dealers_and_newsstands | non_fi_money_orders | non_fi_stored_value_card_purchase_load | nondurable_goods | nurseries_lawn_and_garden_supply_stores | nursing_personal_care | office_and_commercial_furniture | opticians_eyeglasses | optometrists_ophthalmologist | orthopedic_goods_prosthetic_devices | osteopaths | package_stores_beer_wine_and_liquor | paints_varnishes_and_supplies | parking_lots_garages | passenger_railways | pawn_shops | pet_shops_pet_food_and_supplies | petroleum_and_petroleum_products | photo_developing | photographic_photocopy_microfilm_equipment_and_supplies | photographic_studios | picture_video_production | piece_goods_notions_and_other_dry_goods | plumbing_heating_equipment_and_supplies | political_organizations | postal_services_government_only | precious_stones_and_metals_watches_and_jewelry | professional_services | public_warehousing_and_storage | quick_copy_repro_and_blueprint | railroads | real_estate_agents_and_managers_rentals | record_stores | recreational_vehicle_rentals | religious_goods_stores | religious_organizations | roofing_siding_sheet_metal | secretarial_support_services | security_brokers_dealers | service_stations | sewing_needlework_fabric_and_piece_goods_stores | shoe_repair_hat_cleaning | shoe_stores | small_appliance_repair | snowmobile_dealers | special_trade_services | specialty_cleaning | sporting_goods_stores | sporting_recreation_camps | sports_and_riding_apparel_stores | sports_clubs_fields | stamp_and_coin_stores | stationary_office_supplies_printing_and_writing_paper | stationery_stores_office_and_school_supply_stores | swimming_pools_sales | t_ui_travel_germany | tailors_alterations | tax_payments_government_agencies | tax_preparation_services | taxicabs_limousines | telecommunication_equipment_and_telephone_sales | telecommunication_services | telegraph_services | tent_and_awning_shops | testing_laboratories | theatrical_ticket_agencies | timeshares | tire_retreading_and_repair | tolls_bridge_fees | tourist_attractions_and_exhibits | towing_services | trailer_parks_campgrounds | transportation_services | travel_agencies_tour_operators | truck_stop_iteration | truck_utility_trailer_rentals | typesetting_plate_making_and_related_services | typewriter_stores | u_s_federal_government_agencies_or_departments | uniforms_commercial_clothing | used_merchandise_and_secondhand_stores | utilities | variety_stores | veterinary_services | video_amusement_game_supplies | video_game_arcades | video_tape_rental_stores | vocational_trade_schools | watch_jewelry_repair | welding_repair | wholesale_clubs | wig_and_toupee_stores | wires_money_orders | womens_accessory_and_specialty_shops | womens_ready_to_wear_stores | wrecking_and_salvage_yards" ],
    "blocked_categories" : [ "string. Possible values: ac_refrigeration_repair | accounting_bookkeeping_services | advertising_services | agricultural_cooperative | airlines_air_carriers | airports_flying_fields | ambulance_services | amusement_parks_carnivals | antique_reproductions | antique_shops | aquariums | architectural_surveying_services | art_dealers_and_galleries | artists_supply_and_craft_shops | auto_and_home_supply_stores | auto_body_repair_shops | auto_paint_shops | auto_service_shops | automated_cash_disburse | automated_fuel_dispensers | automobile_associations | automotive_parts_and_accessories_stores | automotive_tire_stores | bail_and_bond_payments | bakeries | bands_orchestras | barber_and_beauty_shops | betting_casino_gambling | bicycle_shops | billiard_pool_establishments | boat_dealers | boat_rentals_and_leases | book_stores | books_periodicals_and_newspapers | bowling_alleys | bus_lines | business_secretarial_schools | buying_shopping_services | cable_satellite_and_other_pay_television_and_radio | camera_and_photographic_supply_stores | candy_nut_and_confectionery_stores | car_and_truck_dealers_new_used | car_and_truck_dealers_used_only | car_rental_agencies | car_washes | carpentry_services | carpet_upholstery_cleaning | caterers | charitable_and_social_service_organizations_fundraising | chemicals_and_allied_products | chidrens_and_infants_wear_stores | child_care_services | chiropodists_podiatrists | chiropractors | cigar_stores_and_stands | civic_social_fraternal_associations | cleaning_and_maintenance | clothing_rental | colleges_universities | commercial_equipment | commercial_footwear | commercial_photography_art_and_graphics | commuter_transport_and_ferries | computer_network_services | computer_programming | computer_repair | computer_software_stores | computers_peripherals_and_software | concrete_work_services | construction_materials | consulting_public_relations | correspondence_schools | cosmetic_stores | counseling_services | country_clubs | courier_services | court_costs | credit_reporting_agencies | cruise_lines | dairy_products_stores | dance_hall_studios_schools | dating_escort_services | dentists_orthodontists | department_stores | detective_agencies | direct_marketing_catalog_merchant | direct_marketing_combination_catalog_and_retail_merchant | direct_marketing_inbound_telemarketing | direct_marketing_insurance_services | direct_marketing_other | direct_marketing_outbound_telemarketing | direct_marketing_subscription | direct_marketing_travel | discount_stores | doctors | door_to_door_sales | drapery_window_covering_and_upholstery_stores | drinking_places | drug_stores_and_pharmacies | drugs_drug_proprietaries_and_druggist_sundries | dry_cleaners | durable_goods | duty_free_stores | eating_places_restaurants | educational_services | electric_razor_stores | electrical_parts_and_equipment | electrical_services | electronics_repair_shops | electronics_stores | elementary_secondary_schools | employment_temp_agencies | equipment_rental | exterminating_services | family_clothing_stores | fast_food_restaurants | financial_institutions | fines_government_administrative_entities | fireplace_fireplace_screens_and_accessories_stores | floor_covering_stores | florists | florists_supplies_nursery_stock_and_flowers | freezer_and_locker_meat_provisioners | fuel_dealers_non_automotive | funeral_services_crematories | furniture_home_furnishings_and_equipment_stores_except_appliances | furniture_repair_refinishing | furriers_and_fur_shops | general_services | gift_card_novelty_and_souvenir_shops | glass_paint_and_wallpaper_stores | glassware_crystal_stores | golf_courses_public | government_services | grocery_stores_supermarkets | hardware_equipment_and_supplies | hardware_stores | health_and_beauty_spas | hearing_aids_sales_and_supplies | heating_plumbing_a_c | hobby_toy_and_game_shops | home_supply_warehouse_stores | hospitals | hotels_motels_and_resorts | household_appliance_stores | industrial_supplies | information_retrieval_services | insurance_default | insurance_underwriting_premiums | intra_company_purchases | jewelry_stores_watches_clocks_and_silverware_stores | landscaping_services | laundries | laundry_cleaning_services | legal_services_attorneys | luggage_and_leather_goods_stores | lumber_building_materials_stores | manual_cash_disburse | marinas_service_and_supplies | masonry_stonework_and_plaster | massage_parlors | means_womens_clothing_stores | medical_and_dental_labs | medical_dental_ophthalmic_and_hospital_equipment_and_supplies | medical_services | membership_organizations | mens_and_boys_clothing_and_accessories_stores | metal_service_centers | miscellaneous | miscellaneous_apparel_and_accessory_shops | miscellaneous_auto_dealers | miscellaneous_business_services | miscellaneous_food_stores | miscellaneous_general_merchandise | miscellaneous_general_services | miscellaneous_home_furnishing_specialty_stores | miscellaneous_publishing_and_printing | miscellaneous_recreation_services | miscellaneous_repair_shops | miscellaneous_specialty_retail | mobile_home_dealers | motion_picture_theaters | motor_freight_carriers_and_trucking | motor_homes_dealers | motor_vehicle_supplies_and_new_parts | motorcycle_shops_and_dealers | motorcycle_shops_dealers | music_stores_musical_instruments_pianos_and_sheet_music | news_dealers_and_newsstands | non_fi_money_orders | non_fi_stored_value_card_purchase_load | nondurable_goods | nurseries_lawn_and_garden_supply_stores | nursing_personal_care | office_and_commercial_furniture | opticians_eyeglasses | optometrists_ophthalmologist | orthopedic_goods_prosthetic_devices | osteopaths | package_stores_beer_wine_and_liquor | paints_varnishes_and_supplies | parking_lots_garages | passenger_railways | pawn_shops | pet_shops_pet_food_and_supplies | petroleum_and_petroleum_products | photo_developing | photographic_photocopy_microfilm_equipment_and_supplies | photographic_studios | picture_video_production | piece_goods_notions_and_other_dry_goods | plumbing_heating_equipment_and_supplies | political_organizations | postal_services_government_only | precious_stones_and_metals_watches_and_jewelry | professional_services | public_warehousing_and_storage | quick_copy_repro_and_blueprint | railroads | real_estate_agents_and_managers_rentals | record_stores | recreational_vehicle_rentals | religious_goods_stores | religious_organizations | roofing_siding_sheet_metal | secretarial_support_services | security_brokers_dealers | service_stations | sewing_needlework_fabric_and_piece_goods_stores | shoe_repair_hat_cleaning | shoe_stores | small_appliance_repair | snowmobile_dealers | special_trade_services | specialty_cleaning | sporting_goods_stores | sporting_recreation_camps | sports_and_riding_apparel_stores | sports_clubs_fields | stamp_and_coin_stores | stationary_office_supplies_printing_and_writing_paper | stationery_stores_office_and_school_supply_stores | swimming_pools_sales | t_ui_travel_germany | tailors_alterations | tax_payments_government_agencies | tax_preparation_services | taxicabs_limousines | telecommunication_equipment_and_telephone_sales | telecommunication_services | telegraph_services | tent_and_awning_shops | testing_laboratories | theatrical_ticket_agencies | timeshares | tire_retreading_and_repair | tolls_bridge_fees | tourist_attractions_and_exhibits | towing_services | trailer_parks_campgrounds | transportation_services | travel_agencies_tour_operators | truck_stop_iteration | truck_utility_trailer_rentals | typesetting_plate_making_and_related_services | typewriter_stores | u_s_federal_government_agencies_or_departments | uniforms_commercial_clothing | used_merchandise_and_secondhand_stores | utilities | variety_stores | veterinary_services | video_amusement_game_supplies | video_game_arcades | video_tape_rental_stores | vocational_trade_schools | watch_jewelry_repair | welding_repair | wholesale_clubs | wig_and_toupee_stores | wires_money_orders | womens_accessory_and_specialty_shops | womens_ready_to_wear_stores | wrecking_and_salvage_yards" ],
    "max_amount" : "integer"
  },
  "status" : "Specifies whether to permit authorizations on this card. Possible values are `active` or `inactive`."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "name" : "The cardholder's name. This will be printed on cards issued to them.",
  "phone_number" : "The cardholder's phone number. This will be transformed to [E.164](https://en.wikipedia.org/wiki/E.164) if it is not provided in that format already.",
  "type" : "The type of cardholder. Possible values are `individual` or `business_entity`.",
  "email" : "The cardholder's email address.",
  "billing" : {
    "address" : {
      "country" : "Required string",
      "city" : "Required string",
      "state" : "string",
      "postal_code" : "Required string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "name" : "string"
  },
  "status" : "Specifies whether to permit authorizations on this cardholder's cards. Possible values are `active` or `inactive`."
}

$body#

Type: object

{
  "reason" : "The reason for the dispute, which can be chosen out of a set of valid values.",
  "amount" : "Amount to dispute, defaults to full value, given in the currency the transaction was made in.",
  "expand" : [ "string" ],
  "metadata" : { },
  "evidence" : {
    "other" : {
      "dispute_explanation" : "Required string",
      "uncategorized_file" : "string"
    },
    "fraudulent" : {
      "dispute_explanation" : "Required string",
      "uncategorized_file" : "string"
    }
  },
  "disputed_transaction" : "The ID of the issuing transaction to create a dispute for."
}

account (required)#

The identifier of the account to create a login link for.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ],
  "redirect_url" : "Where to redirect the user after they log out of their dashboard."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "coupon" : "A coupon code that represents a discount to be applied to this order. Must be one-time duration and in same currency as the order.",
  "shipping" : {
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "phone" : "string",
    "name" : "Required string"
  },
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "items" : [ {
    "parent" : "string",
    "amount" : "integer",
    "quantity" : "integer",
    "description" : "string",
    "currency" : "string",
    "type" : "string. Possible values: discount | shipping | sku | tax"
  } ],
  "email" : "The email address of the customer placing the order.",
  "customer" : "The ID of an existing customer to use for this order. If provided, the customer email and shipping address will be used to create the order. Subsequently, the customer will also be charged to pay the order. If `email` or `shipping` are also provided, they will override the values retrieved from the customer object."
}

id (required)#

Type: string

$body#

Type: object

{
  "expand" : [ "string" ],
  "items" : [ {
    "parent" : "string",
    "amount" : "integer",
    "quantity" : "integer",
    "description" : "string",
    "type" : "string. Possible values: discount | shipping | sku | tax"
  } ]
}

$body#

Type: object

{
  "metadata" : { },
  "destination" : {
    "amount" : "integer",
    "account" : "Required string"
  },
  "description" : "string",
  "external_id" : "string",
  "source" : "string",
  "invoice_source" : "string",
  "statement_descriptor" : "string",
  "shipping" : {
    "carrier" : "string",
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "phone" : "string",
    "name" : "Required string",
    "tracking_number" : "string"
  },
  "alternate_statement_descriptors" : {
    "kanji" : "string",
    "kana" : "string"
  },
  "idempotency_key" : "string",
  "currency" : "Required string",
  "payment_method" : "string",
  "user_agent" : "string",
  "order" : "string",
  "include" : [ "string" ],
  "amount" : "Required integer",
  "payment_user_agent" : "string",
  "transfer_group" : "string",
  "device_id" : "string",
  "exchange_rate" : "number",
  "on_behalf_of" : "string",
  "recurring" : "boolean",
  "ip" : "string",
  "cross_border_classification" : "string. Possible values: export",
  "capture" : "boolean",
  "referrer" : "string",
  "expand" : [ "string" ],
  "application" : "string",
  "receipt_email" : "string",
  "statement_address" : {
    "city" : "Required string",
    "state" : "Required string",
    "postal_code" : "Required string",
    "line2" : "string",
    "line1" : "Required string"
  },
  "uncaptured" : "boolean",
  "application_fee" : "integer",
  "invoice" : "string",
  "card_program" : "string",
  "level3" : {
    "shipping_amount" : "integer",
    "merchant_reference" : "Required string",
    "customer_reference" : "string",
    "shipping_address_zip" : "string",
    "line_items" : [ {
      "tax_amount" : "integer",
      "quantity" : "integer",
      "discount_amount" : "integer",
      "unit_cost" : "integer",
      "product_code" : "Required string",
      "product_description" : "Required string"
    } ],
    "shipping_from_zip" : "string"
  },
  "customer" : "string"
}

$body#

Type: object

{
  "capture_method" : "Capture method of this PaymentIntent, one of `automatic` or `manual`.",
  "amount" : "Amount intended to be collected by this PaymentIntent",
  "metadata" : { },
  "transfer_group" : "A string that identifies the resulting payment as part of a group. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) for details.",
  "allowed_source_types" : [ "string" ],
  "description" : "An arbitrary string attached to the object. Often useful for displaying to users.",
  "source" : "ID of the Source object to attach to this PaymentIntent.",
  "statement_descriptor" : "Extra information about a PaymentIntent. This will appear on your customer's statement when this PaymentIntent succeeds in creating a charge.",
  "transfer_data" : {
    "amount" : "integer",
    "destination" : "Required string"
  },
  "expand" : [ "string" ],
  "shipping" : {
    "carrier" : "string",
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "Required string"
    },
    "phone" : "string",
    "name" : "Required string",
    "tracking_number" : "string"
  },
  "receipt_email" : "Email address that the receipt for the resulting payment will be sent to.",
  "return_url" : "The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site.If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "save_source_to_customer" : "`true` to save this PaymentIntent's Source to the associated Customer, if the Source is not already attached.",
  "attempt_confirmation" : "Attempt to confirm this PaymentIntent on source attachment.",
  "application_fee_amount" : "The amount of the application fee (if any) that will be applied to the payment and transferred to theapplication owner's Stripe account. To use an application fee, therequest must be made on behalf of another account, using the`Stripe-Account` header or an OAuth key. For more information, see[Collecting applicationfees](/docs/connect/direct-charges#collecting-fees).",
  "customer" : "ID of the customer this PaymentIntent is for if one exists."
}

$body#

Type: object

{
  "statement_descriptor" : "A string to be displayed on the recipient's bank or card statement. This may be at most 22 characters. Attempting to use a `statement_descriptor` longer than 22 characters will return an error. Note: Most banks will truncate this information and/or display it inconsistently. Some may not display it at all.",
  "amount" : "A positive integer in cents representing how much to payout.",
  "expand" : [ "string" ],
  "metadata" : { },
  "method" : "The method used to send this payout, which can be `standard` or `instant`. `instant` is only supported for payouts to debit cards. (See [Instant payouts for marketplaces for more information](https://stripe.com/blog/instant-payouts-for-marketplaces).)",
  "destination" : "The ID of a bank account or a card to send the payout to. If no destination is supplied, the default external account for the specified currency will be used.",
  "description" : "An arbitrary string attached to the object. Often useful for displaying to users.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "source_type" : "The source balance to draw this payout from. Balances for different payment sources are kept separately. You can find the amounts with the balances API. Valid options are: **alipay_account**, **bank_account**, and **card**."
}

$body#

Type: object

{
  "interval_count" : "The number of intervals between subscription billings. For example, `interval=month` and `interval_count=3` bills every 3 months. Maximum of one year interval allowed (1 year, 12 months, or 52 weeks).",
  "amount" : "A positive integer in %s (or 0 for a free plan) representing how much to charge on a recurring basis.",
  "metadata" : { },
  "product" : {
    "statement_descriptor" : "string",
    "metadata" : { },
    "name" : "Required string",
    "active" : "boolean",
    "id" : "string",
    "unit_label" : "string"
  },
  "tiers" : [ {
    "up_to" : { },
    "unit_amount" : "integer"
  } ],
  "transform_usage" : {
    "round" : "Required string. Possible values: down | up",
    "divide_by" : "Required integer"
  },
  "active" : "Whether the plan is currently available for new subscriptions. Defaults to `true`.",
  "aggregate_usage" : "Specifies a usage aggregation strategy for plans of `usage_type=metered`. Allowed values are `sum` for summing up all usage during a period, `last_during_period` for picking the last usage record reported within a period, `last_ever` for picking the last usage record ever (across period bounds) or `max` which picks the usage record with the maximum reported usage during a period. Defaults to `sum`.",
  "billing_scheme" : "Describes how to compute the price per period. Either `per_unit` or `tiered`. `per_unit` indicates that the fixed amount (specified in `amount`) will be charged per unit in `quantity` (for plans with `usage_type=licensed`), or per unit of total usage (for plans with `usage_type=metered`). `tiered` indicates that the unit pricing will be computed using a tiering strategy as defined using the `tiers` and `tiers_mode` attributes.",
  "trial_period_days" : "Default number of trial days when subscribing a customer to this plan using [`trial_from_plan=true`](/docs/api#create_subscription-trial_from_plan).",
  "statement_descriptor" : "An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. The statement description may not include <>\"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. It must contain at least one letter.",
  "tiers_mode" : "Defines if the tiering price should be `graduated` or `volume` based. In `volume`-based tiering, the maximum quantity within a period determines the per unit price, in `graduated` tiering pricing can successively change as the quantity grows.",
  "expand" : [ "string" ],
  "usage_type" : "Configures how the quantity per period should be determined, can be either `metered` or `licensed`. `licensed` will automatically bill the `quantity` set for a plan when adding it to a subscription, `metered` will aggregate the total usage based on usage records. Defaults to `licensed`.",
  "name" : "The plan name. Customers may see this value on Stripe-generated invoices and receipts.",
  "nickname" : "A brief description of the plan, hidden from customers.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "interval" : "Specifies billing frequency. Either `day`, `week`, `month` or `year`.",
  "id" : "An identifier randomly generated by Stripe. Used to identify this plan when subscribing a customer. You can optionally override this ID, but the ID must be unique across all plans in your Stripe account. You can, however, use the same plan ID in both live and test modes."
}

id (required)#

The identifier of the application fee to be refunded.

Type: string

$body#

Type: object

{
  "amount" : "A positive integer, in _%s_, representing how much of this fee to refund. Can refund only up to the remaining unrefunded amount of the fee.",
  "expand" : [ "string" ],
  "metadata" : { }
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "operator_account" : "If the request is being made from the platform account but the reader is being operated by a connected account, indicate the operating account."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "address" : {
    "country" : "Required string",
    "city" : "Required string",
    "state" : "string",
    "postal_code" : "Required string",
    "line2" : "string",
    "line1" : "Required string"
  },
  "display_name" : "A name for the location.",
  "operator_account" : "If the request is being made from the platform account but the reader is being operated by a connected account, indicate the operating account."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "registration_code" : "A code generated by the reader used for registering to an account.",
  "location" : "The location to assign the reader to. If no location is specified, the reader will be assigned to the account's default location.",
  "label" : "Custom label given to the reader for easier identification. If no label is specified, the registration code will be used.",
  "operator_account" : "If the request is being made from the platform account but the reader is being operated by a connected account, indicate the operating account."
}

$body#

Type: object

{
  "deactivate_on" : [ "string" ],
  "images" : [ "string" ],
  "metadata" : { },
  "active" : "Whether the product is currently available for purchase. Defaults to `true`.",
  "caption" : "A short one-line description of the product, meant to be displayable to the customer. May only be set if type=`good`.",
  "description" : "The product's description, meant to be displayable to the customer. May only be set if type=`good`.",
  "type" : "The type of the product. The product is either of type `service`, which is eligible for use with Subscriptions and Plans or `good`, which is eligible for use with Orders and SKUs.",
  "url" : "A URL of a publicly-accessible webpage for this product. May only be set if type=`good`.",
  "package_dimensions" : {
    "length" : "Required number",
    "width" : "Required number",
    "weight" : "Required number",
    "height" : "Required number"
  },
  "statement_descriptor" : "An arbitrary string to be displayed on your customer's credit card statement. This may be up to 22 characters. The statement description may not include <>\"' characters, and will appear on your customer's statement in capital letters. Non-ASCII characters are automatically stripped. While most banks display this information consistently, some may display it incorrectly or not at all. It must contain at least one letter. May only be set if type=`service`.",
  "expand" : [ "string" ],
  "shippable" : "Whether this product is shipped (i.e., physical goods). Defaults to `true`. May only be set if type=`good`.",
  "name" : "The product's name, meant to be displayable to the customer. Applicable to both `service` and `good` types.",
  "attributes" : [ "string" ],
  "id" : "An identifier will be randomly generated by Stripe. You can optionally override this ID, but the ID must be unique across all products in your Stripe account. Applicable to both `service` and `good` types.",
  "unit_label" : "A label that represents units of this product, such as seat(s), in Stripe and on customers’ receipts and invoices. Only available on products of type=`service`."
}

$body#

Type: object

{
  "reason" : "string. Possible values: duplicate | fraudulent | requested_by_customer",
  "amount" : "integer",
  "expand" : [ "string" ],
  "metadata" : { },
  "charge" : "string",
  "refund_application_fee" : "boolean",
  "description" : "string",
  "reverse_transfer" : "boolean",
  "directive" : { }
}

$body#

Type: object

{
  "package_dimensions" : {
    "length" : "Required number",
    "width" : "Required number",
    "weight" : "Required number",
    "height" : "Required number"
  },
  "image" : "The URL of an image for this SKU, meant to be displayable to the customer.",
  "expand" : [ "string" ],
  "metadata" : { },
  "product" : "The ID of the product this SKU is associated with. Must be a product with type `good`.",
  "price" : "The cost of the item as a nonnegative integer in the smallest currency unit (that is, 100 cents to charge $1.00, or 100 to charge ¥100, Japanese Yen being a zero-decimal currency).",
  "active" : "Whether the SKU is available for purchase. Default to `true`.",
  "attributes" : "A dictionary of attributes and values for the attributes defined by the product. If, for example, a product's attributes are `[\"size\", \"gender\"]`, a valid SKU has the following dictionary of attributes: `{\"size\": \"Medium\", \"gender\": \"Unisex\"}`.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "id" : "The identifier for the SKU. Must be unique. If not provided, an identifier will be randomly generated.",
  "inventory" : {
    "quantity" : "integer",
    "type" : "string. Possible values: bucket | finite | infinite",
    "value" : "string. Possible values:  | in_stock | limited | out_of_stock"
  }
}

$body#

Type: object

{
  "owner" : {
    "address" : {
      "country" : "string",
      "city" : "string",
      "state" : "string",
      "postal_code" : "string",
      "line2" : "string",
      "line1" : "string"
    },
    "phone" : "string",
    "name" : "string",
    "email" : "string"
  },
  "redirect" : {
    "return_url" : "Required string"
  },
  "amount" : "Amount associated with the source. This is the amount for which the source will be chargeable once ready. Required for `single_use` sources.",
  "mandate" : {
    "notification_method" : "string. Possible values: email | manual | none",
    "acceptance" : {
      "date" : "Required integer",
      "ip" : "Required string",
      "user_agent" : "Required string",
      "status" : "Required string. Possible values: accepted | pending | refused | revoked"
    }
  },
  "metadata" : { },
  "receiver" : {
    "refund_attributes_method" : "string. Possible values: email | manual | none"
  },
  "usage" : "string. Possible values: reusable | single_use",
  "type" : "The `type` of the source to create. Required unless `customer` and `original_source` are specified (see the [Shared card Sources](/docs/sources/connect#shared-card-sources) guide)",
  "original_source" : "The source to share.",
  "token" : "An optional token used to create the source. When passed, token properties will override source parameters.",
  "statement_descriptor" : "An arbitrary string to be displayed on your customer's statement. As an example, if your website is `RunClub` and the item you're charging for is a race ticket, you may want to specify a `statement_descriptor` of `RunClub 5K race ticket.` While many payment types will display this information, some may not display it at all.",
  "expand" : [ "string" ],
  "currency" : "Three-letter [ISO code for the currency](https://stripe.com/docs/currencies) associated with the source. This is the currency for which the source will be chargeable once ready.",
  "flow" : "The authentication `flow` of the source to create. `flow` is one of `redirect`, `receiver`, `code_verification`, `none`. It is generally inferred unless a type supports multiple flows.",
  "customer" : "The `Customer` to whom the original source is attached to. Must be set when the original source is not a `Source` (e.g., `Card`)."
}

$body#

Type: object

{
  "metadata" : { },
  "cancel_at_period_end" : "Boolean indicating whether this subscription should cancel at the end of the current period.",
  "coupon" : "The code of the coupon to apply to this subscription. A coupon applied to a subscription will only affect invoices created for that particular subscription.",
  "days_until_due" : "Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where `billing` is set to `send_invoice`.",
  "trial_end" : "Unix timestamp representing the end of the trial period the customer will get before being charged for the first time. This will always overwrite any trials that might apply via a subscribed plan. If set, trial_end will override the default trial period of the plan the customer is being subscribed to. The special value `now` can be provided to end the customer's trial immediately.",
  "trial_period_days" : "Integer representing the number of trial period days before the customer is charged for the first time. This will always overwrite any trials that might apply via a subscribed plan.",
  "application_fee_percent" : "A non-negative decimal between 0 and 100, with at most two decimal places. This represents the percentage of the subscription invoice subtotal that will be transferred to the application owner's Stripe account. The request must be made with an OAuth key in order to set an application fee percentage. For more information, see the application fees [documentation](https://stripe.com/docs/connect/subscriptions#collecting-fees-on-subscriptions).",
  "billing_cycle_anchor" : "A future timestamp to anchor the subscription's [billing cycle](/docs/subscriptions/billing-cycle). This is used to determine the date of the first full invoice, and, for plans with `month` or `year` intervals, the day of the month for subsequent invoices.",
  "billing" : "Either `charge_automatically`, or `send_invoice`. When charging automatically, Stripe will attempt to pay this subscription at the end of the cycle using the default source attached to the customer. When sending an invoice, Stripe will email your customer an invoice with payment instructions. Defaults to `charge_automatically`.",
  "tax_percent" : "A non-negative decimal (with at most four decimal places) between 0 and 100. This represents the percentage of the subscription invoice subtotal that will be calculated and added as tax to the final amount in each billing period. For example, a plan which charges $10/month with a `tax_percent` of `20.0` will charge $12 per invoice. To unset a previously-set value, pass an empty string.",
  "expand" : [ "string" ],
  "trial_from_plan" : "Indicates if a plan's `trial_period_days` should be applied to the subscription. Setting `trial_end` per subscription is preferred, and this defaults to `false`. Setting this flag to `true` together with `trial_end` is not allowed.",
  "items" : [ {
    "quantity" : "integer",
    "plan" : "Required string"
  } ],
  "prorate" : "Boolean (defaults to `true`) telling us whether to [credit for unused time](/docs/subscriptions/billing-cycle#prorations) when the billing cycle changes (e.g. when switching plans, resetting `billing_cycle_anchor=now`, or starting a trial). If `false`, the anchor period will be free (similar to a trial) and no proration adjustments will be created.",
  "customer" : "The identifier of the customer to subscribe."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "quantity" : "The quantity you'd like to apply to the subscription item you're creating.",
  "subscription" : "The identifier of the subscription to modify.",
  "plan" : "The identifier of the plan to add to the subscription.",
  "prorate" : "Flag indicating whether to [prorate](/docs/subscriptions/upgrading-downgrading#understanding-proration) switching plans during a billing cycle.",
  "proration_date" : "If set, the proration will be calculated as though the subscription was updated at the given time. This can be used to apply the same proration that was previewed with the [upcoming invoice](#retrieve_customer_invoice) endpoint."
}

$body#

Type: object

{
  "statement_descriptor" : "Extra information about a top-up for the source's bank statement. Limited to 15 ASCII characters.",
  "amount" : "A positive integer in %s representing how much to transfer.",
  "expand" : [ "string" ],
  "metadata" : { },
  "transfer_group" : "A string that identifies this top-up as part of a group.",
  "description" : "An arbitrary string attached to the object. Often useful for displaying to users.",
  "currency" : "Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies).",
  "source" : "The ID of a source to transfer funds from. For most users, this should be left unspecified which will use the bank account that was set up in the dashboard for the specified currency. In test mode, this can be a test bank token (see [Testing Top-ups](/docs/connect/testing#testing-top-ups))."
}

$body#

Type: object

{
  "amount" : "A positive integer in %s representing how much to transfer.",
  "expand" : [ "string" ],
  "metadata" : { },
  "transfer_group" : "A string that identifies this transaction as part of a group. See the [Connect documentation](/docs/connect/charges-transfers#grouping-transactions) for details.",
  "destination" : "The ID of a connected Stripe account. See the Connect documentation for details.",
  "description" : "An arbitrary string attached to the object. Often useful for displaying to users.",
  "source_transaction" : "You can use this parameter to transfer funds from a charge before they are added to your available balance. A pending balance will transfer immediately but the funds will not become available until the original charge becomes available. [See the Connect documentation](/docs/connect/charges-transfers#transfer-availability) for details.",
  "currency" : "3-letter [ISO code for currency](/docs/payouts)."
}

$body#

Type: object

{
  "expand" : [ "string" ],
  "metadata" : { },
  "name" : "The recipient's full, legal name. For type `individual`, should be in the format `First Last`, `First Middle Last`, or `First M Last` (no prefixes or suffixes). For `corporation`, the full, incorporated name.",
  "description" : "An arbitrary string which you can attach to a `Recipient` object. It is displayed alongside the recipient in the web interface.",
  "type" : "Type of the recipient: either `individual` or `corporation`.",
  "card" : { },
  "email" : "The recipient's email address. It is displayed alongside the recipient in the web interface, and can be useful for searching and tracking.",
  "tax_id" : "The recipient's tax ID, as a string. For type `individual`, the full SSN; for type `corporation`, the full EIN.",
  "bank_account" : { }
}

id (required)#

The ID of the transfer to be reversed.

Type: string

$body#

Type: object

{
  "amount" : "A positive integer in %s representing how much of this transfer to reverse. Can only reverse up to the unreversed amount remaining of the transfer. Partial transfer reversals are only allowed for transfers to Stripe Accounts. Defaults to the entire transfer amount.",
  "expand" : [ "string" ],
  "metadata" : { },
  "refund_application_fee" : "Boolean indicating whether the application fee should be refunded when reversing this transfer. If a full transfer reversal is given, the full application fee will be refunded. Otherwise, the application fee will be refunded with an amount proportional to the amount of the transfer reversed.",
  "description" : "An arbitrary string which you can attach to a reversal object. It is displayed alongside the reversal in the Dashboard. This will be unset if you POST an empty value."
}

subscription_item (required)#

The ID of the subscription item for this usage record.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ],
  "quantity" : "The usage quantity for the specified timestamp.",
  "action" : "Valid values are `increment` (default) or `set`. When using `increment` the specified `quantity` will be added to the usage at the specified timestamp. The `set` action will overwrite the usage quantity at that timestamp.",
  "timestamp" : "The timestamp for the usage event. This timestamp must be within the current billing period of the subscription of the provided `subscription_item`."
}

authorization (required)#

The identifier of the issuing authorization to decline.

Type: string

$body#

Type: object

{
  "expand" : [ "string" ]
}

account (required)#

The identifier of the account to be deleted. If none is provided, will default to the account of the API key.

Type: string

account (required)#

Type: string

id (required)#

The ID of the external account to be deleted.

Type: string

coupon (required)#

The identifier of the coupon to be deleted.

Type: string

customer (required)#

The identifier of the customer to be deleted.

Type: string

customer (required)#

Type: string

customer (required)#

Type: string

id (required)#

The ID of the source to be deleted.

Type: string

invoiceitem (required)#

The identifier of the invoice item to be deleted.

Type: string

plan (required)#

The identifier of the plan to be deleted.

Type: string

id (required)#

The ID of the product to delete.

Type: string

id (required)#

The identifier of the SKU to be deleted.

Type: string

subscription_exposed_id (required)#

Type: string

subscription_exposed_id (required)#

Type: string

item (required)#

The identifier of the subscription item to delete.

Type: string

id (required)#

The identifier of the recipient to be deleted.

Type: string

account (required)#

The identifier of the account to retrieve. If none is provided, the account associated with the API key is returned.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

available_on#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

currency#

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

payout#

For automatic Stripe payouts only, only returns transactions that were payed out on the specified payout ID.

Type: string

source#

Only returns the original transaction.

Type: string

type#

Only returns transactions of the given type. One of: charge, refund, adjustment, application_fee, application_fee_refund, transfer, payment, payout, payout_failure, stripe_fee, or network_cost.

Type: string

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

customer#

Only return charges for the customer specified by this customer ID.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

source#

A filter on the list, based on the source of the charge. The value can be a dictionary with the following options:

Type: object

{
  "object" : "string"
}

transfer_group#

Only return charges for this transfer group.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

created#

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

customer (required)#

The ID of the customer whose sources will be retrieved.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

object#

Filter sources according to a particular object type.

Type: string

type#

Type: string

customer (required)#

The ID of the customer whose subscriptions will be retrieved.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

email#

A filter on the list based on the customer's email field. The value must be a string.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

account (required)#

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

expired#

Filter links by their expiration status. By default, all links are returned.

Type: boolean

file#

Only return links for the given file.

Type: string

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

purpose#

The file purpose to filter queries by. If none is provided, files will not be filtered by purpose.

Type: string

Potential values: additional_verification, bootstrap_pilot_user_report, business_logo, customer_signature, dispute_evidence, finance_report_run, founders_stock_document, identity_document, incorporation_article, incorporation_document, india_export_payment_advice, invoice_statement, paper_check_image, payment_provider_transfer, pci_document, product_feed, sigma_scheduled_query, support_attachment, tandem_accepted, tandem_requested, tandem_voidance, tax_document, tax_document_user_upload, works_with_image

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

customer#

The identifier of the customer whose invoice items to return. If none is provided, all invoice items will be returned.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

invoice#

Only return invoice items belonging to this invoice. If none is provided, all invoice items will be returned. If specifying an invoice, no customer identifier is needed.

Type: string

invoice (required)#

The ID of the invoice containing the lines to be retrieved.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

billing#

The billing mode of the invoice to retrieve. Either charge_automatically or send_invoice.

Type: string

Potential values: charge_automatically, send_invoice

customer#

Only return invoices for the customer specified by this customer ID.

Type: string

date#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

due_date#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

subscription#

Only return invoices for the subscription specified by this subscription ID.

Type: string

card#

Only return issuing transactions that belong to the given card.

Type: string

cardholder#

Only return authorizations belonging to the given cardholder.

Type: string

created#

Only return authorizations that were created during the given date interval.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

status#

Only return authorizations with the given status. One of pending, closed, or reversed.

Type: string

Potential values: closed, pending, reversed

created#

Only return cardholders that were created during the given date interval.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

email#

Only return cardholders that have the given email address.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

phone_number#

Only return cardholders that have the given phone number.

Type: string

status#

Only return cardholders that have the given status. One of active or inactive.

Type: string

Potential values: active, inactive

type#

Only return cardholders that have the given type. One of One of individual or business_entity.

Type: string

Potential values: business_entity, individual

cardholder#

Only return cards belonging to the Cardholder with the provided ID.

Type: string

created#

Only return cards that were issued during the given date interval.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

exp_month#

Only return cards that have the given expiration month.

Type: integer

exp_year#

Only return cards that have the given expiration year.

Type: integer

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

last4#

Only return cards that have the given last four digits.

Type: string

name#

Only return cards that have the given name.

Type: string

source#

Only return cards whose full card number matches that of this card source ID.

Type: string

status#

Only return cards that have the given status. One of active, inactive, or canceled.

Type: string

Potential values: active, canceled, inactive, lost, pending_compliance, stolen

type#

Only return cards that have the given type. One of virtual or physical.

Type: string

Potential values: physical, virtual

created#

Only return issuing disputes that were created during the given date interval.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

disputed_transaction#

Only return issuing disputes for the given transaction.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

card#

Only return issuing transactions that belong to the given card.

Type: string

cardholder#

Only return authorizations belonging to the given cardholder.

Type: string

created#

Only return transactions that were created during the given date interval.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

delivery_success#

Filter events by whether all webhooks were successfully delivered. If false, events which are still pending or have failed all delivery attempts to a webhook endpoint will be returned.

Type: boolean

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

type#

A string containing a specific event name, or group of events using * as a wildcard. The list will be filtered to include only events with a matching event property.

Type: string

types#

An array of up to 20 strings containing specific event names. The list will be filtered to include only events with a matching event property. You may pass either type or types, but not both.

Type: array

[ "string" ]

created#

Date this return was created.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

order#

The order to retrieve returns for.

Type: string

created#

Date this order was created.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

customer#

Only return orders for the given customer.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

ids#

Only return orders with the given IDs.

Type: array

[ "string" ]

status#

Only return orders that have the given status. One of created, paid, fulfilled, or refunded.

Type: string

status_transitions#

Filter orders based on when they were paid, fulfilled, canceled, or returned.

Type: object

{
  "canceled" : {
    "lt" : "integer",
    "gte" : "integer",
    "lte" : "integer",
    "gt" : "integer"
  },
  "fulfilled" : {
    "lt" : "integer",
    "gte" : "integer",
    "lte" : "integer",
    "gt" : "integer"
  },
  "paid" : {
    "lt" : "integer",
    "gte" : "integer",
    "lte" : "integer",
    "gt" : "integer"
  },
  "returned" : {
    "lt" : "integer",
    "gte" : "integer",
    "lte" : "integer",
    "gt" : "integer"
  }
}

upstream_ids#

Only return orders with the given upstream order IDs.

Type: array

[ "string" ]

created#

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

arrival_date#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

destination#

The ID of an external account - only return payouts sent to this external account.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

status#

Only return payouts that have the given status: pending, paid, failed, or canceled.

Type: string

active#

Only return plans that are active or inactive (e.g., pass false to list all inactive products).

Type: boolean

created#

A filter on the list, based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with a number of different query options.

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

product#

Only return plans for the given product.

Type: string

charge#

Only return application fees for the charge specified by this charge ID.

Type: string

created#

Type: object

{
  "lt" : "integer",
  "gte" : "integer",
  "lte" : "integer",
  "gt" : "integer"
}

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

id (required)#

The ID of the application fee whose refunds will be retrieved.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

operator_account#

The identifier of the account associated with this location.

Type: string

expand#

Specifies which fields in the response should be expanded.

Type: array

[ "string" ]

location#

A location id to filter the response list to only readers at the specific location

Type: string