Retrieves a Customer object.
" }, { "info": { "name": "Stripe Post Customers Customer", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates the specified customer by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the source parameter, that becomes the customer’s active source (e.g., a card) to be used for all charges in the future. When you update a customer to a new valid card source by passing the source parameter: for each of the customer’s current subscriptions, if the subscription bills automatically and is in" }, { "info": { "name": "Stripe Delete Customers Customer", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "
Permanently deletes a customer. It cannot be undone. Also immediately cancels any active subscriptions on the customer.
" }, { "info": { "name": "Stripe Get Customers Customer Balance Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that updated the customer’s balances.
" }, { "info": { "name": "Stripe Post Customers Customer Balance Transactions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates an immutable transaction that updates the customer’s credit balance.
" }, { "info": { "name": "Stripe Get Customers Customer Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific customer balance transaction that updated the customer’s balances.
" }, { "info": { "name": "Stripe Post Customers Customer Balance Transactions Transaction", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Most credit balance transaction fields are immutable, but you may update its description and metadata.
You can see a list of the bank accounts belonging to a Customer. Note that the 10 most recent sources are always available by default on the Customer. If you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional bank accounts.
When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
By default, you can see the 10 most recent sources stored on a Customer directly on the object, but you can also retrieve details about a specific bank account stored on the Stripe account.
" }, { "info": { "name": "Stripe Post Customers Customer Bank Accounts Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/bank_accounts/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Update a specified source for a given customer.
" }, { "info": { "name": "Stripe Delete Customers Customer Bank Accounts Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/bank_accounts/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Delete a specified source for a given customer.
" }, { "info": { "name": "Stripe Post Customers Customer Bank Accounts Id Verify", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/bank_accounts/:id/verify", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Verify a specified bank account for a given customer.
" }, { "info": { "name": "Stripe Get Customers Customer Cards", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cards", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can see a list of the cards belonging to a customer.\nNote that the 10 most recent sources are always available on the Customer object.\nIf you need more than those 10, you can use this API method and the limit and starting_after parameters to page through additional cards.
When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
You can always see the 10 most recent cards directly on a customer; this method lets you retrieve details about a specific card stored on the customer.
" }, { "info": { "name": "Stripe Post Customers Customer Cards Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/cards/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Update a specified source for a given customer.
" }, { "info": { "name": "Stripe Delete Customers Customer Cards Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/cards/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Delete a specified source for a given customer.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a customer’s cash balance.
" }, { "info": { "name": "Stripe Post Customers Customer Cash Balance", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Changes the settings on a customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of transactions that modified the customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Cash Balance Transactions Transaction", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/cash_balance_transactions/:transaction", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "transaction", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a specific cash balance transaction, which updated the customer’s cash balance.
" }, { "info": { "name": "Stripe Get Customers Customer Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Stripe Get Customers Customer Discount" }, { "info": { "name": "Stripe Delete Customers Customer Discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/discount", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Removes the currently applied discount on a customer.
" }, { "info": { "name": "Stripe Post Customers Customer Funding Instructions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/funding_instructions", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieve funding instructions for a customer cash balance. If funding instructions do not yet exist for the customer, new\nfunding instructions will be created. If funding instructions have already been created for a given customer, the same\nfunding instructions will be retrieved. In other words, we will return the same funding instructions each time.
" }, { "info": { "name": "Stripe Get Customers Customer Payment Methods", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/payment_methods", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." }, { "name": "type", "value": "", "type": "query", "description": "An optional filter on the list, based on the object `type` field. Without the filter, the list includes all current and future payment method types. If your integration expects only one type of payment method in the response, make sure to provide a type value in the request." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of PaymentMethods for a given Customer
" }, { "info": { "name": "Stripe Get Customers Customer Payment Methods Payment Method", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/payment_methods/:payment_method", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "payment_method", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves a PaymentMethod object for a given Customer.
" }, { "info": { "name": "Stripe Get Customers Customer Sources", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/sources", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "object", "value": "", "type": "query", "description": "Filter sources according to a particular object type." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "List sources for a specified customer.
" }, { "info": { "name": "Stripe Post Customers Customer Sources", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/sources", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "When you create a new credit card, you must specify a customer or recipient on which to create it.
\n\nIf the card’s owner has no default card, then the new card will become the default.\nHowever, if the owner already has a default, then it will not change.\nTo change the default, you should update the customer to have a new default_source.
Retrieve a specified source for a given customer.
" }, { "info": { "name": "Stripe Post Customers Customer Sources Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/sources/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Update a specified source for a given customer.
" }, { "info": { "name": "Stripe Delete Customers Customer Sources Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/sources/:id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Delete a specified source for a given customer.
" }, { "info": { "name": "Stripe Post Customers Customer Sources Id Verify", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/sources/:id/verify", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Verify a specified bank account for a given customer.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "You can see a list of the customer’s active subscriptions. Note that the 10 most recent active subscriptions are always available by default on the customer object. If you need more than those 10, you can use the limit and starting_after parameters to page through additional subscriptions.
" }, { "info": { "name": "Stripe Post Customers Customer Subscriptions", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new subscription on an existing customer.
" }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Retrieves the subscription with the given ID.
" }, { "info": { "name": "Stripe Post Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Updates an existing subscription on a customer to match the specified parameters. When changing plans or quantities, we will optionally prorate the price we charge next month to make up for any price changes. To preview how the proration will be calculated, use the upcoming invoice endpoint.
" }, { "info": { "name": "Stripe Delete Customers Customer Subscriptions Subscription Exposed Id", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Cancels a customer’s subscription. If you set the at_period_end parameter to true, the subscription will remain active until the end of the period, at which point it will be canceled and not renewed. Otherwise, with the default false value, the subscription is terminated immediately. In either case, the customer will not be charged again for the subscription.
Note, however, that any pending invoice items that you’ve created will still be charged " }, { "info": { "name": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Stripe Get Customers Customer Subscriptions Subscription Exposed Id Discount" }, { "info": { "name": "Stripe Delete Customers Customer Subscriptions Subscription Exposed Id Discount", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stripe.com/v1/customers/:customer/subscriptions/:subscription_exposed_id/discount", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "subscription_exposed_id", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "
Removes the currently applied discount on a customer.
" }, { "info": { "name": "Stripe Get Customers Customer Tax Ids", "type": "http" }, "http": { "method": "GET", "url": "https://api.stripe.com/v1/customers/:customer/tax_ids", "params": [ { "name": "customer", "value": "", "type": "path" }, { "name": "ending_before", "value": "", "type": "query", "description": "A cursor for use in pagination. `ending_before` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with `obj_bar`, your subsequent call can include `ending_before=obj_bar` in order to fetch the previous page of the list." }, { "name": "expand", "value": "", "type": "query", "description": "Specifies which fields in the response should be expanded." }, { "name": "limit", "value": "", "type": "query", "description": "A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10." }, { "name": "starting_after", "value": "", "type": "query", "description": "A cursor for use in pagination. `starting_after` is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with `obj_foo`, your subsequent call can include `starting_after=obj_foo` in order to fetch the next page of the list." } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Returns a list of tax IDs for a customer.
" }, { "info": { "name": "Stripe Post Customers Customer Tax Ids", "type": "http" }, "http": { "method": "POST", "url": "https://api.stripe.com/v1/customers/:customer/tax_ids", "params": [ { "name": "customer", "value": "", "type": "path" } ], "body": { "type": "form-urlencoded", "data": [] } }, "docs": "Creates a new tax_id object for a customer.
Retrieves the tax_id object with the given identifier.
Deletes an existing tax_id object.
Manually reconcile the remaining amount for a customer_balance PaymentIntent.