Updateable Stripe objects—including Account, Charge, Customer, PaymentIntent, Refund, Subscription, and Transfer have a metadata parameter. You can use this parameter to attach key-value data to these Stripe objects.
You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.
You can use metadata to store additional, structured information on an object. For example, you could store your user’s full name and corresponding unique identifier from your system on a Stripe Customer object. Stripe doesn’t use metadata—for example, we don’t use it to authorize or decline a charge and it won’t be seen by your users unless you choose to show it to them.
Some of the objects listed above also support a description parameter. You can use the description parameter to annotate a charge-for example, a human-readable description such as 2 shirts for test@example.. Unlike metadata, description is a single string, which your users might see (for example, in email receipts Stripe sends on your behalf).
Don’t store any sensitive information (bank account numbers, card details, and so on) as metadata or in the description parameter.
- Related guide: Metadata
Sample metadata use cases
- Link IDs: Attach your system’s unique IDs to a Stripe object to simplify lookups. For example, add your order number to a charge, your user ID to a customer or recipient, or a unique receipt number to a transfer.
- Refund papertrails: Store information about the reason for a refund and the individual responsible for its creation.
- Customer details: Annotate a customer by storing an internal ID for your future use.
{ "id": "cus_123456789", "object": "customer", "address": { "city": "city", "country": "US", "line1": "line 1", "line2": "line 2", "postal_code": "90210", "state": "CA" }, "balance": 0, "created": 1483565364, "currency": null, "default_source": null, "delinquent": false, "description": null, "discount": null, "email": null, "invoice_prefix": "C11F7E1", "invoice_settings": { "custom_fields": null, "default_payment_method": null, "footer": null, "rendering_options": null }, "livemode": false, "metadata": { "order_id": "6735" }, "name": null, "next_invoice_sequence": 1, "phone": null, "preferred_locales": [], "shipping": null, "tax_exempt": "none"}All top-level API resources have support for bulk fetches through “list” API methods. For example, you can list charges, list customers, and list invoices. These list API methods share a common structure and accept, at a minimum, the following three parameters: limit, starting_, and ending_.
Stripe’s list API methods use cursor-based pagination through the starting_ and ending_ parameters. Both parameters accept an existing object ID value (see below) and return objects in reverse chronological order. The ending_ parameter returns objects listed before the named object. The starting_ parameter returns objects listed after the named object. These parameters are mutually exclusive. You can use either the starting_ or ending_ parameter, but not both simultaneously.
Our client libraries offer auto-pagination helpers to traverse all pages of a list.
Parameters
- limitoptional, default is 10
This specifies a limit on the number of objects to return, ranging between 1 and 100.
- starting_
afteroptional object ID A cursor to use in pagination.
starting_is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, ending withafter obj_, your subsequent call can includefoo starting_to fetch the next page of the list.after=obj_ foo - ending_
beforeoptional object ID A cursor to use in pagination.
ending_is an object ID that defines your place in the list. For example, if you make a list request and receive 100 objects, starting withbefore obj_, your subsequent call can includebar ending_to fetch the previous page of the list.before=obj_ bar
List Response Format
- objectstring, value is "list"
A string that provides a description of the object type that returns.
- dataarray
An array containing the actual response elements, paginated by any request parameters.
- has_
moreboolean Whether or not there are more elements available after this set. If
false, this set comprises the end of the list. - urlurl
The URL for accessing this list.
{ "object": "list", "url": "/v1/customers", "has_more": false, "data": [ { "id": "cus_4QFJOjw2pOmAGJ", "object": "customer", "address": null, "balance": 0, "created": 1405641735, "currency": "usd", "default_source": "card_14HOpG2eZvKYlo2Cz4u5AJG5", "delinquent": false, "description": "New customer", "discount": null, "email": null, "invoice_prefix": "7D11B54", "invoice_settings": { "custom_fields": null, "default_payment_method": null, "footer": null, "rendering_options": null }, "livemode": false, "metadata": { "order_id": "6735" }, "name": "cus_4QFJOjw2pOmAGJ", "next_invoice_sequence": 25, "phone": null, "preferred_locales": [], "shipping": null, "tax_exempt": "none", "test_clock": null }, ]}Some top-level API resource have support for retrieval via “search” API methods. For example, you can search charges, search customers, and search subscriptions.
Stripe’s search API methods utilize cursor-based pagination via the page request parameter and next_ response parameter. For example, if you make a search request and receive "next_ in the response, your subsequent call can include page=pagination_ to fetch the next page of results.
Our client libraries offer auto-pagination helpers to easily traverse all pages of a search result.
Search request format
- queryrequired
The search query string. See search query language.
- limitoptional
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
- pageoptional
A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the
next_value returned in a previous response to request subsequent results.page
Search response format
- objectstring, value is "search_result"
A string describing the object type returned.
- urlstring
The URL for accessing this list.
- has_
moreboolean Whether or not there are more elements available after this set. If
false, this set comprises the end of the list. - dataarray
An array containing the actual response elements, paginated by any request parameters.
- next_
pagestring A cursor for use in pagination. If
has_is true, you can pass the value ofmore next_to a subsequent call to fetch the next page of results.page - total_
countoptional positive integer or zero The total number of objects that match the query, only accurate up to 10,000. This field isn’t included by default. To include it in the response, expand the
total_field.count
{ "object": "search_result", "url": "/v1/customers/search", "has_more": false, "data": [ { "id": "cus_4QFJOjw2pOmAGJ", "object": "customer", "address": null, "balance": 0, "created": 1405641735, "currency": "usd", "default_source": "card_14HOpG2eZvKYlo2Cz4u5AJG5", "delinquent": false, "discount": null, "email": null, "invoice_prefix": "7D11B54", "invoice_settings": { "custom_fields": null, "default_payment_method": null, "footer": null, "rendering_options": null }, "livemode": false, "metadata": { "foo": "bar" }, "name": "fakename", "next_invoice_sequence": 25, "phone": null, "preferred_locales": [], "shipping": null, "tax_exempt": "none", "test_clock": null } ]}Our libraries support auto-pagination. This feature allows you to easily iterate through large lists of resources without having to manually perform the requests to fetch subsequent pages.
Each API request has an associated request identifier. You can find this value in the response headers, under Request-Id. You can also find request identifiers in the URLs of individual request logs in your Dashboard.
To expedite the resolution process, provide the request identifier when you contact us about a specific request.