Stripe Component
Manage objects connected to your Stripe platform
Component key: stripe#
DescriptionThe Stripe component provides functionality for interacting with the Stripe API .
#
Stripe Connections#
Stripe ConnectionThe Stripe component uses API keys to authenticate requests. You can view and manage your API keys in the Stripe Dashboard. For information on obtaining an API key from Stripe, refer to the docs
Input | Notes |
---|---|
Input API Key string / Required | Notes Provide a string value for the API Key. |
#
Triggers#
WebhookTrigger for handling webhooks from Stripe | key: webhook
You can configure a Stripe event notification webhook to send information to a Prismatic webhook URL under certain conditions (a "Product" is created, a "Order" is updated, etc.).
Additionally, you can reference a trigger's results.webhookUrls to create a webhook in a deploy-triggered flow. That'll configure webhooks to point to an instance when that instance is deployed to a customer.
#
Output Example Payload{ "payload": { "headers": { "accept": "*/*", "Content-Type": "application/json; charset=UTF-8", "Stripe-Signature": "Example-Stripe-Signature", "User-Agent": "Stripe/1.0 (+https://stripe.com/docs/webhooks)", "Host": "hooks.example.prismatic.io" }, "body": { "data": { "id": "evt_example302r", "object": "event", "api_version": "2020-08-27", "created": "103920", "data": { "id": "example_prod_39u42432", "object": "Product", "active": "true", "created": "123320112", "description": "Ths is an example Product Description.", "livemode": True, "name": "Example Product Name", "type": "service" } }, "contentType": "application/json; charset=UTF-8" }, "rawBody": { "data": { "type": "Buffer", "data": [69, 120, 97, 109, 112, 108, 101] } }, "queryParameters": { "user_id": "ExampleUserId", "user_key": "ExampleUserKey" }, "webhookUrls": { "Flow 1": "https://hooks.example.prismatic.io/trigger/EXAMPLEGbG93Q29uZmlnOmRlNmNmNDMyLTliNWMtN0005NDMxLTRmYzA4ZjViODgxOA==" }, "webhookApiKeys": { "Flow 1": ["abc-123"] }, "customer": { "externalId": "customer-example-external-id", "name": "John Doe" } }}
#
Actions#
Attach CardAttach a card to a customer | key: attachCard
Input | Notes | Example |
---|---|---|
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Create CardCreate a new card | key: createCard
Input | Notes | Example |
---|---|---|
Input Billing Street Address string | Notes Provide a value for the street address of the billing information | Example 4 privet drive |
Input Billing Address 2 string | Notes Provide a value for the optional second address field of the billing information | Example suite 3 |
Input Billing City string | Notes Provide a value for the city of the billing information | Example Los Angeles |
Input Billing Country string | Notes Provide a value for the country of the billing information | Example United States |
Input Billing State string | Notes Provide a value for the email of the billing information | Example someone@example.com |
Input Full Name string | Notes Provide a value for the name of the billing information | Example John Doe |
Input Card Number string / Required | Notes Provide a value for the number of the card. | Example 48594932905594544 |
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input CVC string / Required | Notes Provide a value for the CVC on the back of the card. | Example 937 |
Input Expiration Month string / Required | Notes Provide a value for the expiration month of the card. | Example 09 |
Input Expiration Year string / Required | Notes Provide a value for the expiration year of the card. | Example 2021 |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Billing State string | Notes Provide a value for the phone of the billing information | Example 18005554545 |
Input Billing Postal Code string | Notes Provide a value for the postal code of the billing information | Example 90432 |
Input Billing State string | Notes Provide a value for the state of the billing information | Example California |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Create CustomerCreate a new customer object | key: createCustomer
Input | Notes | Example |
---|---|---|
Input Address Line 1 string | Notes Provide a string value for street address of the customer. | Example 4, Privet Drive |
Input Address Line 2 string | Notes Provide a string value for street address of the customer. | Example suite 3 |
Input Balance string | Notes Provide a number value for balance of the customer. | Example 5000 |
Input City string | Notes Provide a string value for city of the customer. | Example Buffalo |
Input Country string | Notes Provide a string value for country of the customer. | Example United States |
Input Description string | Notes Provide a string value for description of the customer. | Example This is an example description. |
Input Email string | Notes Provide a string value for email of the customer. | Example someone@example.com |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | Example |
Input Name string | Notes provide a string value for the name of the customer. | Example John Doe |
Input Default Payment Method Id string | Notes Provide the unique identifier of the customer's default payment method. | Example pm_1JaiTbDtJQgcyrdS08EmyHHe |
Input Phone string | Notes The maximum time a client will await a response. | Example 18005554545 |
Input Postal Code string | Notes Provide a string value for postal code of the customer. | Example 90410 |
Input State string | Notes Provide a string value for state of the customer. | Example New York |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Create InvoiceCreate a new invoice | key: createInvoice
Input | Notes | Example |
---|---|---|
Input Auto Advance boolean | Notes Controls whether Stripe will perform automatic collection of the invoice. | Example |
Input Collection Method string | Notes Provide a value for the collection method of the invoice. | Example |
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Description string | Notes Provide a value for the description of the invoice. | Example This is an example description. |
Input Due Date string | Notes Provide a unix timestamp value for the due date of the invoice. | Example 1631824986 |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Connection connection / Required | Notes | Example |
Input Subscription Id string | Notes Provide a string value for unique identifier of the subscription. | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Create PriceCreate a new price | key: createPrice
Input | Notes | Example |
---|---|---|
Input Active boolean / Required | Notes This flag will specify if the object is currently active in your platform. | Example |
Input Currency string | Notes Three-letter ISO currency code, in lowercase. Must be a supported currency. | Example usd |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Nickname string | Notes A brief description of the price, hidden from customers. | Example |
Input Product Id string / Required | Notes Provide a string value for the unique identifier of the product | Example prod_KEomQOHnUBtMNr |
Input RecurringInterval string | Notes Provide a value that specifies billing frequency. | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
Input Unit Price string | Notes Provide a value for the price per unit. | Example |
#
Create ProductCreate a new product | key: createProduct
Input | Notes | Example |
---|---|---|
Input Active boolean / Required | Notes This flag will specify if the object is currently active in your platform. | Example |
Input Description string | Notes Provide a value for the description of the invoice. | Example This is an example description. |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Product Caption string | Notes A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good. | Example This is an example caption. |
Input Product Images string Value List | Notes For each list item, provide a URL for the image of the product | Example www.exampleImageURL.com/product1 |
Input Product Name string / Required | Notes Provide a string value for the name of the product | Example myProduct |
Input Product Type string | Notes Provide a string value for the type of the product | Example Service |
Input Product URL string | Notes A URL of a publicly-accessible webpage for this product. May only be set if type=good. | Example |
Input Shippable boolean | Notes Whether this product is able to be shipped (i.e., physical goods). | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Create SubscriptionCreate a new subscription | key: createSubscription
Input | Notes | Example |
---|---|---|
Input Cancel At string | Notes A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. | Example 0208302 |
Input Collection Method string | Notes Provide a value for the collection method of the invoice. | Example |
Input Coupon string | Notes Provide a value for the unique identifier of the coupon for the invoice. | Example Z4OV52SU |
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Days Until Due string | Notes Provide a value for the days until the payment is due | Example 23 |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Price Id string / Required | Notes Provide a value for the unique identifier of the price. | Example price_1JaOXaDtJQgcyrdSRnsI9KW5 |
Input Quantity string | Notes Provide a string value for quantity of the items in the subscription. | Example 30 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Delete CustomerPermanently deletes a customer, Also immediately cancels any active subscriptions on the customer. | key: deleteCustomer
Input | Notes | Example |
---|---|---|
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Output Example Payload{ "data": { "id": "94304", "object": "customer", "deleted": true }}
#
Delete InvoiceDelete an existing invoice | key: deleteInvoice
Input | Notes | Example |
---|---|---|
Input invoiceId string / Required | Notes Provide a value for the unique identifier of the invoice. | Example 849305 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Delete ProductDelete an existing product by Id | key: deleteProduct
Input | Notes | Example |
---|---|---|
Input Product Id string / Required | Notes Provide a string value for the unique identifier of the product | Example prod_KEomQOHnUBtMNr |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Delete SubscriptionDelete a subscription by Id | key: deleteSubscription
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Subscription Id string | Notes Provide a string value for unique identifier of the subscription. | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Detach CardDetach a card from a customer | key: detachCard
Input | Notes | Example |
---|---|---|
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Get CardGet the information and metadata of a card by Id | key: getCard
Input | Notes | Example |
---|---|---|
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Get CustomerRetrieve the information and metadata of a customer by Id | key: getCustomer
Input | Notes | Example |
---|---|---|
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Output Example Payload{ "data": { "id": "94304", "object": "customer", "deleted": true }}
#
Get InvoiceGet the information and metadata of an invoice by Id | key: getInvoice
Input | Notes | Example |
---|---|---|
Input invoiceId string / Required | Notes Provide a value for the unique identifier of the invoice. | Example 849305 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Get PriceGet the information and metadata of a price by Id | key: getPrice
Input | Notes | Example |
---|---|---|
Input Price Id string / Required | Notes Provide a value for the unique identifier of the price. | Example price_1JaOXaDtJQgcyrdSRnsI9KW5 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Get ProductGet the information and metadata of a product by Id | key: getProduct
Input | Notes | Example |
---|---|---|
Input Product Id string / Required | Notes Provide a string value for the unique identifier of the product | Example prod_KEomQOHnUBtMNr |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Get SubscriptionsGet the information and metadata of a subscription by Id | key: getSubscription
Input | Notes | Example |
---|---|---|
Input Connection connection / Required | Notes | Example |
Input Subscription Id string | Notes Provide a string value for unique identifier of the subscription. | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List AccountsReturns a list of accounts connected to your platform | key: listAccounts
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List CardsReturns a list of cards connected to your platform | key: listCards
Input | Notes | Example |
---|---|---|
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Ending Before string | Notes 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. | Example obj903234 |
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List ChargesReturns a list of all charges | key: listCharges
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List CustomersReturns a list of customers | key: listCustomers
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List InvoicesReturns a list of invoices connected to your platform | key: listInvoices
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List PricesReturns a list of all available prices | key: listPrices
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List ProductsReturns a list of products connected to your platform | key: listProducts
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
List SubscriptionsReturns a list of subscriptions | key: listSubscriptions
Input | Notes | Example |
---|---|---|
Input Limit string | Notes Provide an integer value for the maximum amount of results that will be returned. | Example 100 |
Input Starting After string | Notes 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. | Example obj903234 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Update CardCreate a new card by Id | key: updateCard
Input | Notes | Example |
---|---|---|
Input Billing Street Address string | Notes Provide a value for the street address of the billing information | Example 4 privet drive |
Input Billing Address 2 string | Notes Provide a value for the optional second address field of the billing information | Example suite 3 |
Input Billing City string | Notes Provide a value for the city of the billing information | Example Los Angeles |
Input Billing Country string | Notes Provide a value for the country of the billing information | Example United States |
Input Billing State string | Notes Provide a value for the email of the billing information | Example someone@example.com |
Input Full Name string | Notes Provide a value for the name of the billing information | Example John Doe |
Input Card Number string / Required | Notes Provide a value for the number of the card. | Example 48594932905594544 |
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input CVC string / Required | Notes Provide a value for the CVC on the back of the card. | Example 937 |
Input Expiration Month string / Required | Notes Provide a value for the expiration month of the card. | Example 09 |
Input Expiration Year string / Required | Notes Provide a value for the expiration year of the card. | Example 2021 |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Billing State string | Notes Provide a value for the phone of the billing information | Example 18005554545 |
Input Billing Postal Code string | Notes Provide a value for the postal code of the billing information | Example 90432 |
Input Billing State string | Notes Provide a value for the state of the billing information | Example California |
Input Connection connection / Required | Notes | Example |
#
Update CustomerCreate a new customer object | key: updateCustomer
Input | Notes | Example |
---|---|---|
Input Address Line 1 string | Notes Provide a string value for street address of the customer. | Example 4, Privet Drive |
Input Address Line 2 string | Notes Provide a string value for street address of the customer. | Example suite 3 |
Input Balance string | Notes Provide a number value for balance of the customer. | Example 5000 |
Input City string | Notes Provide a string value for city of the customer. | Example Buffalo |
Input Country string | Notes Provide a string value for country of the customer. | Example United States |
Input Description string | Notes Provide a string value for description of the customer. | Example This is an example description. |
Input Email string | Notes Provide a string value for email of the customer. | Example someone@example.com |
Input Customer Id string | Notes Provide a string value for unique identifier of the customer. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. | Example |
Input Name string | Notes provide a string value for the name of the customer. | Example John Doe |
Input Phone string | Notes The maximum time a client will await a response. | Example 18005554545 |
Input Postal Code string | Notes Provide a string value for postal code of the customer. | Example 90410 |
Input State string | Notes Provide a string value for state of the customer. | Example New York |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Update InvoiceUpdate an existing invoice | key: updateInvoice
Input | Notes | Example |
---|---|---|
Input Application Fee Amount string | Notes Provide a value for the application fee of the invoice. You should only provide this value if you selected 'Charge Automatically' in the collection method input. | Example 500 |
Input Auto Advance boolean | Notes Controls whether Stripe will perform automatic collection of the invoice. | Example |
Input Collection Method string | Notes Provide a value for the collection method of the invoice. | Example |
Input Coupon string | Notes Provide a value for the unique identifier of the coupon for the invoice. | Example Z4OV52SU |
Input Description string | Notes Provide a value for the description of the invoice. | Example This is an example description. |
Input Discount string | Notes Provide a value for the discount of the invoice. | Example 78983 |
Input Due Date string | Notes Provide a unix timestamp value for the due date of the invoice. | Example 1631824986 |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input invoiceId string / Required | Notes Provide a value for the unique identifier of the invoice. | Example 849305 |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Payment Method Id string | Notes Provide a value for the unique identifier of the payment. | Example pm_003494 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Update PriceUpdate an existing price by Id | key: updatePrice
Input | Notes | Example |
---|---|---|
Input Active boolean / Required | Notes This flag will specify if the object is currently active in your platform. | Example |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Nickname string | Notes A brief description of the price, hidden from customers. | Example |
Input Price Id string / Required | Notes Provide a value for the unique identifier of the price. | Example price_1JaOXaDtJQgcyrdSRnsI9KW5 |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
#
Update ProductUpdate an existing product | key: updateProduct
Input | Notes | Example |
---|---|---|
Input Active boolean / Required | Notes This flag will specify if the object is currently active in your platform. | Example |
Input Description string | Notes Provide a value for the description of the invoice. | Example This is an example description. |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Product Caption string | Notes A short one-line description of the product, meant to be displayable to the customer. May only be set if type=good. | Example This is an example caption. |
Input Product Id string / Required | Notes Provide a string value for the unique identifier of the product | Example prod_KEomQOHnUBtMNr |
Input Product Images string Value List | Notes For each list item, provide a URL for the image of the product | Example www.exampleImageURL.com/product1 |
Input Product URL string | Notes A URL of a publicly-accessible webpage for this product. May only be set if type=good. | Example |
Input Shippable boolean | Notes Whether this product is able to be shipped (i.e., physical goods). | Example |
Input Connection connection / Required | Notes | Example |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |
Input Product Name string | Notes Provide a string value for the name of the product | Example myProduct |
#
Update SubscriptionUpdate an existing subscription | key: updateSubscription
Input | Notes | Example |
---|---|---|
Input Cancel At string | Notes A timestamp at which the subscription should cancel. If set to a date before the current period ends, this will cause a proration if prorations have been enabled using proration_behavior. If set during a future period, this will always cause a proration for that period. | Example 0208302 |
Input Collection Method string | Notes Provide a value for the collection method of the invoice. | Example |
Input Coupon string | Notes Provide a value for the unique identifier of the coupon for the invoice. | Example Z4OV52SU |
Input Values string Key Value List | Notes The names of optional fields and their values to use when creating/updating a record. For example, if you have a custom configured field that is not represented as an input, here you are able to specify its key and assign it a value. | Example |
Input Metadata string Key Value List | Notes Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. | Example |
Input Quantity string | Notes Provide a string value for quantity of the items in the subscription. | Example 30 |
Input Connection connection / Required | Notes | Example |
Input Subscription Id string | Notes Provide a string value for unique identifier of the subscription. | Example |
Input Price Id string | Notes Provide a value for the unique identifier of the price. | Example price_1JaOXaDtJQgcyrdSRnsI9KW5 |
Input Timeout string | Notes The maximum time a client will await a response. | Example 2000 |