Wiresk

Wiresk

Stripe – Methods

Estimated reading time: 29 min
STRIPE 1 Stripe - Methods

What your automation will do…

You can include between 1 and 255 Methods to build complex Flows.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature (⚡ icon).

(*) required field

Name* Retrieve Records
Connection* Select your connection or create one.
Entity*Stripe entity to query: Payment links, Payment link Line Items, Checkout session and Subscription.

Matching Criteria

Record ID*

The unique Stripe ID of the selected entity.

You can:

  • Select a record from list.
  • Map it dynamically from a previous Trigger or Method if your Flow works.

If not Found consider as

Success – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the Flow.

Failed – Wiresk treats this as an error or failure. The Flow stops or takes a predefined failure action.

Sample response for payment links entity 
{
  "id": "string",
  "object": "payment_link",
  "active": false,
  "after_completion": {
    "hosted_confirmation": {
      "custom_message": null
    },
    "type": "hosted_confirmation"
  },
  "allow_promotion_codes": false,
  "application": null,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_address_collection": "auto",
  "consent_collection": null,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "after_submit": null,
    "shipping_address": null,
    "submit": null,
    "terms_of_service_acceptance": null
  },
  "customer_creation": "if_required",
  "inactive_message": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": [],
      "rendering_options": null
    }
  },
  "livemode": false,
  "metadata": [],
  "on_behalf_of": null,
  "payment_intent_data": null,
  "payment_method_collection": "always",
  "payment_method_types": null,
  "phone_number_collection": {
    "enabled": false
  },
  "restrictions": null,
  "shipping_address_collection": null,
  "shipping_options": [],
  "submit_type": "auto",
  "subscription_data": {
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "metadata": [],
    "trial_period_days": 7,
    "trial_settings": {
      "end_behavior": {
        "missing_payment_method": "create_invoice"
      }
    }
  },
  "tax_id_collection": {
    "enabled": false,
    "required": "never"
  },
  "transfer_data": null,
  "url": "https://buy.stripe.com/test_string"
}
Expand

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature (⚡ icon).

(*) required field

Name* Create Record
Connection* Select your connection or create one.
Entity*Payment links, Checkout session and Subscription.

Creates a payment link.

Map Fields ⨁ Add Mapping

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

After the purchase is complete

Action*

Choice:

Redirect to URL: Redirects the customer to the specified url after the purchase is complete. you must set Redirect config

Display a message: Displays a message on the hosted surface after the purchase is complete. You must set Hosted config.

Hosted configure

Custom message: Message to display

Redirect config

Redirect URL: The URL the customer will be redirected to after the purchase is complete.

Allow promotion codes

Whether user redeemable promotion codes are enabled.

Automatic tax

Configuration details for automatic tax collection.

If true, tax will be calculated automatically using the customer’s location.

Collecting billing address

Choices:

  • Auto: Checkout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.
  • Required: Checkout will always collect the customer’s billing address.

Collecting consent

Payment method reuse agreement: Determines the display of payment method reuse agreement text in the UI. If set to hidden, it will hide legal text related to the reuse of a payment method.

  • auto
    • Uses Stripe defaults to determine the visibility and position of the payment method reuse agreement.
  • hidden
    • Hides the payment method reuse agreement.

Promotions: If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.

  • auto
    • Enable the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on if a customer is provided, and if that customer has consented to receiving promotional communications from the merchant in the past.
  • none
    • Checkout will not collect customer consent for promotional communications.

Terms of service: If set to required, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your Dashboard settings.

  • none
    • Does not display checkbox for the terms of service agreement.
  • required
    • Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay.
⨁ Add Field

Price ID

The ID of the price object. You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item. Defaults to 1.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: The ID of the tax rate. You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

Currency (ISO Code)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Custom Text

Display additional text for your customers using custom text.

After Submit: Custom text that should be displayed after the payment confirmation button.

Shipping Address: Custom text that should be displayed alongside shipping address collection.

Submit: Custom text that should be displayed alongside the payment confirmation button.

Terms Of Service Acceptance: Custom text that should be displayed in place of the default terms of service agreement text.

Customer Creation

Can only be used if the payment link does not contain any recurring prices.

Choices:

  • Always: The Checkout Session will always create a Customer when a Session confirmation is attempted.
  • If required: The Checkout Session will only create a Customer if it is required for Session confirmation. Currently, only subscription mode Sessions and payment mode Sessions with post-purchase invoices enabled require a Customer.

Inactive Message

The custom message to be displayed to a customer when a payment link is no longer active.

Phone number collection

Controls phone number collection settings during checkout.

If true, a phone number will be collected during checkout.

Restrictions

Settings that restrict the usage of a payment link.

Completed sessions* 

Count*: The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.

Limite: The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.

Shipping address collection

Configuration for collecting the customer’s shipping address.

Allowed countries

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Value*: Select a country name in a list.

Subscription data

When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.

Description: The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

Trial period days: Integer representing the number of trial period days before the customer is charged for the first time.

Trial settings: Settings related to subscription trials.

End behavior – Missing payment method:

  • Cancel: Cancel the subscription if a payment method is not attached when the trial ends.
  • Create invoice: Create an invoice when the trial ends, even if the user did not set up a payment method.
  • Pause: Pause the subscription if a payment method is not attached when the trial ends.

Line items*

The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first item.

Price ID*

Price of the Item. You can:

  • Map it from a previous step
  • Use the lookup feature, go to Default value > Lookup tab > search).

Quantity*

Quantity if items.

⨁ Add Field

Allow adjust quantity: When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first adjustment.

Enable*

Set to true if the quantity can be adjusted to any non-negative Integer.

⨁ Add Field

Maximum quantity (Max 999999)

Minimum quantity: By default this value is 0. If there is only one item in the cart then that item’s quantity cannot go down to 0.

Sample response 
{
  "id": "plink_1MoC3ULkdIwHu7ixZjtGpVl2",
  "object": "payment_link",
  "active": true,
  "after_completion": {
    "hosted_confirmation": {
      "custom_message": null
    },
    "type": "hosted_confirmation"
  },
  "allow_promotion_codes": false,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_address_collection": "auto",
  "consent_collection": null,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer_creation": "if_required",
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "metadata": {},
  "on_behalf_of": null,
  "payment_intent_data": null,
  "payment_method_collection": "always",
  "payment_method_types": null,
  "phone_number_collection": {
    "enabled": false
  },
  "shipping_address_collection": null,
  "shipping_options": [],
  "submit_type": "auto",
  "subscription_data": {
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "trial_period_days": null
  },
  "tax_id_collection": {
    "enabled": false
  },
  "transfer_data": null,
  "url": "https://buy.stripe.com/test_cN25nr0iZ7bUa7meUY"
}
Expand

Creates a Checkout Session link.

Map Fields ⨁ Add Mapping

Cancel URL

If set, Checkout displays a back button and customers will be directed to this URL if they decide to cancel payment and return to your website.

Reference the Checkout Session

A unique string to reference the Checkout Session. This can be a customer ID, a cart ID, or similar, and can be used to reconcile the Session with your internal systems.

Currency (ISO Code)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Customer ID

The ID of the customer for this Session. For Checkout Sessions in subscription mode or Checkout Sessions with customer_creation set as always in payment mode, Checkout will create a new customer object based on information provided during the payment flow unless an existing customer was provided when the Session was created.

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

Customer email

If provided, this value will be used when the Customer object is created. If not provided, customers will be asked to enter their email address. Use this parameter to prefill customer data if you already have an email on file. To access information about the customer once the payment flow is complete, use the customer attribute.

Allow promotion codes

Enables user redeemable promotion codes.

Expires at (Default 24h)

The time at which the Checkout Session will expire.

Collecting billing address

Choices:

  • Auto: Checkout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.
  • Required: Checkout will always collect the customer’s billing address.

Discount

List of coupons and promotion codes attached to the Checkout Session.

Coupon ID: The ID of the coupon to apply to this Session.

Promotion Code: The ID of a promotion code to apply to this Session.

Locale

The IETF language tag of the locale Checkout is displayed in. If blank or auto, the browser’s locale is used.

See full list.

Phone number collection

Indicates whether phone number collection is enabled for the session

Subscription data

A subset of parameters to be passed to subscription creation for Checkout Sessions in subscription mode.

Default tax rates: The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription.

Description: The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in the customer portal.

The maximum length is 500 characters.

Trial end: Set either Trial end or Trial period day.

time representing the end of the trial period the customer will get before being charged for the first time. Has to be at least 48 hours in the future.

Trial period day: Set either Trial end or Trial period day.

Integer representing the number of trial period days before the customer is charged for the first time. Has to be at least 1.

Trial settings: Settings related to subscription trials.

End behavior – Missing payment method:

  • Cancel: Cancel the subscription if a payment method is not attached when the trial ends.
  • Create invoice: Create an invoice when the trial ends, even if the user did not set up a payment method.
  • Pause: Pause the subscription if a payment method is not attached when the trial ends.

Checkout session mode*

The mode of the Checkout Session. Pass subscription if the Checkout Session includes at least one recurring item. Choices:

  • Payment: Accept one-time payments for cards, iDEAL, and more.
  • Setup: Save payment details to charge your customers later.
  • Subscription: Use Stripe Billing to set up fixed-price subscriptions.

Success URL*

The URL to which Stripe should send customers when payment or setup is complete. This parameter is not allowed if ui_mode is embedded or custom. If you’d like to use information from the successful Checkout Session on your page, read the guide on customizing your success page.

Items*

A list of items the customer is purchasing. Use this parameter to pass one-time or recurring Prices. The parameter is required for payment and subscription mode.

For payment mode, there is a maximum of 100 line items, however it is recommended to consolidate line items if there are more than a few dozen.

For subscription mode, there is a maximum of 20 line items with recurring Prices and 20 line items with one-time Prices. Line items with one-time Prices will be on the initial invoice only.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first item.

Price ID*

Price of the Item. You can:

  • Map it from a previous step
  • Use the lookup feature, go to Default value > Lookup tab > search).
⨁ Add Field

Quantity: Quantity if items.

Dynamic tax rates: The tax rates that will be applied to this line item depending on the customer’s billing/shipping address. We currently support the following countries: US, GB, AU, and all countries in the EU.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first tax rate.

Value*

Tax rates: The tax rates which apply to this line item.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first tax rate.

Taxe rate*

Sample response 
{
  "id": "cs_test_a11YYufWQzNY63zpQ6QSNRQhkUpVph4WRmzW0zWJO2znZKdVujZ0N0S22u",
  "object": "checkout.session",
  "after_expiration": null,
  "allow_promotion_codes": null,
  "amount_subtotal": 2198,
  "amount_total": 2198,
  "automatic_tax": {
    "enabled": false,
    "liability": null,
    "status": null
  },
  "billing_address_collection": null,
  "cancel_url": null,
  "client_reference_id": null,
  "consent": null,
  "consent_collection": null,
  "created": 1679600215,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer": null,
  "customer_creation": "if_required",
  "customer_details": null,
  "customer_email": null,
  "expires_at": 1679686615,
  "invoice": null,
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "locale": null,
  "metadata": {},
  "mode": "payment",
  "payment_intent": null,
  "payment_link": null,
  "payment_method_collection": "always",
  "payment_method_options": {},
  "payment_method_types": [
    "card"
  ],
  "payment_status": "unpaid",
  "phone_number_collection": {
    "enabled": false
  },
  "recovered_from": null,
  "setup_intent": null,
  "shipping_address_collection": null,
  "shipping_cost": null,
  "shipping_details": null,
  "shipping_options": [],
  "status": "open",
  "submit_type": null,
  "subscription": null,
  "success_url": "https://example.com/success",
  "total_details": {
    "amount_discount": 0,
    "amount_shipping": 0,
    "amount_tax": 0
  },
  "url": "https://checkout.stripe.com/c/pay/cs_test_a11YYufWQzNY63zpQ..."
}
Expand

Creates a new subscription on an existing customer. Each customer can have up to 500 active or scheduled subscriptions.

Map Fields ⨁ Add Mapping

Cancel at period end

Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.

Currency (ISO Code)

Three-letter ISO currency code, in lowercase. Must be a supported currency.

Default payment method

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

You can get the ID from:

  • Previous steps
  • Stripe portal > customers > payment methods > … (ellipsis)

Description

The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

The maximum length is 500 characters.

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

Payment behavior

Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use default_incomplete to transition the subscription to status=past_due when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use pending_if_incomplete to update the subscription using pending updates. When you use pending_if_incomplete you can only pass the parameters supported by pending updates.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

Add invoice items

A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.

⨁ Add Field

Price ID

The ID of the price object. You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item. Defaults to 1.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: The ID of the tax rate. You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

Automatic tax

Configuration details for automatic tax collection.

If true, tax will be calculated automatically using the customer’s location.

Backdate start date

A past timestamp to backdate the subscription’s start date to. If set, the first invoice will contain line items for the timespan between the start date and the current time. Can be combined with trials and the billing cycle anchor.

Billing cycle anchor

Either now or unchanged. Setting the value to now resets the subscription’s billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.

Billing Tresholds

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Usage gte: Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

Reset billing cycle anchor: Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.

Cancel at

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.

Collection method

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 and mark the subscription as active. Defaults to charge_automatically.

Coupon ID

ID of the coupon to create a new discount for.

Day until due

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.

Default tax rates

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription. Pass an empty string to remove previously-defined tax rates.

Off session

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).

Pending invoice item interval

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

Interval*: Specifies invoicing frequency. Either day, week, month or year.

Interval count: The number of intervals between invoices. 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).

Proration date

If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint. proration_date can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.

Promotion Code

ID of the promotion code to create a new discount for.

Proration behavior

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. The default value is create_prorations.

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 billing_cycle_anchor will be updated to the trial_end value. The special value now can be provided to end the customer’s trial immediately. Can be at most two years from billing_cycle_anchor.

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. See Using trial periods on subscriptions to learn more.

Trial settings

Settings related to subscription trials.

End behavior – Missing payment method:

  • Cancel: Cancel the subscription if a payment method is not attached when the trial ends.
  • Create invoice: Create an invoice when the trial ends, even if the user did not set up a payment method.
  • Pause: Pause the subscription if a payment method is not attached when the trial ends.

Cancellation details

Comment: Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.

Feedback: The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user:

  • customer_service: Customer service was less than expected
  • low_quality: Quality was less than expected
  • missing_features: Some features are missing
  • other: Other reason
  • switched_service: I’m switching to a different service
  • too_complex: Ease of use was less than expected
  • too_expensive: It’s too expensive
  • unused: I don’t use the service enough

Customer ID*

The identifier of the customer to subscribe. You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

items*

A list of up to 20 subscription items, each with an attached price.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first item.

Billing Thresholds

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Usage gte*: Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

Price ID

The ID of the price object. You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: The ID of the tax rate.

You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search
Sample response 
{
  "id": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
  "object": "subscription",
  "application": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_cycle_anchor": 1679609767,
  "cancel_at": null,
  "cancel_at_period_end": false,
  "canceled_at": null,
  "cancellation_details": {
    "comment": null,
    "feedback": null,
    "reason": null
  },
  "collection_method": "charge_automatically",
  "created": 1679609767,
  "currency": "usd",
  "customer": "cus_Na6dX7aXxi11N4",
  "days_until_due": null,
  "default_payment_method": null,
  "default_source": null,
  "default_tax_rates": [],
  "description": null,
  "discounts": null,
  "ended_at": null,
  "invoice_settings": {
    "issuer": {
      "type": "self"
    }
  },
  "items": {
    "object": "list",
    "data": [
      {
        "id": "si_Na6dzxczY5fwHx",
        "object": "subscription_item",
        "created": 1679609768,
        "current_period_end": 1682288167,
        "current_period_start": 1679609767,
        "metadata": {},
        "plan": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "plan",
          "active": true,
          "amount": 1000,
          "amount_decimal": "1000",
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "discounts": null,
          "interval": "month",
          "interval_count": 1,
          "livemode": false,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "tiers_mode": null,
          "transform_usage": null,
          "trial_period_days": null,
          "usage_type": "licensed"
        },
        "price": {
          "id": "price_1MowQULkdIwHu7ixraBm864M",
          "object": "price",
          "active": true,
          "billing_scheme": "per_unit",
          "created": 1679609766,
          "currency": "usd",
          "custom_unit_amount": null,
          "livemode": false,
          "lookup_key": null,
          "metadata": {},
          "nickname": null,
          "product": "prod_Na6dGcTsmU0I4R",
          "recurring": {
            "interval": "month",
            "interval_count": 1,
            "trial_period_days": null,
            "usage_type": "licensed"
          },
          "tax_behavior": "unspecified",
          "tiers_mode": null,
          "transform_quantity": null,
          "type": "recurring",
          "unit_amount": 1000,
          "unit_amount_decimal": "1000"
        },
        "quantity": 1,
        "subscription": "sub_1MowQVLkdIwHu7ixeRlqHVzs",
        "tax_rates": []
      }
    ],
    "has_more": false,
    "total_count": 1,
    "url": "/v1/subscription_items?subscription=sub_1MowQVLkdIwHu7ixeRlqHVzs"
  },
  "latest_invoice": "in_1MowQWLkdIwHu7ixuzkSPfKd",
  "livemode": false,
  "metadata": {},
  "next_pending_invoice_item_invoice": null,
  "on_behalf_of": null,
  "pause_collection": null,
  "payment_settings": {
    "payment_method_options": null,
    "payment_method_types": null,
    "save_default_payment_method": "off"
  },
  "pending_invoice_item_interval": null,
  "pending_setup_intent": null,
  "pending_update": null,
  "schedule": null,
  "start_date": 1679609767,
  "status": "active",
  "test_clock": null,
  "transfer_data": null,
  "trial_end": null,
  "trial_settings": {
    "end_behavior": {
      "missing_payment_method": "create_invoice"
    }
  },
  "trial_start": null
}
Expand

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature (⚡ icon).

(*) required field

Name* Create usage Record
Connection* Select your connection or create one.
Entity*Create a usage record

Matching Criteria

Subscription item ID*

Stripe subscriptions can contain multiple items. Each metered price generates a subscription item ID.
You must provide that ID so Stripe knows which item the usage belongs to.

You can:

  • Manually provide the ID
  • Map it dynamically from a previous Trigger or Method if your Flow works.
Map Fields ⨁ Add Mapping

Increment action (default) or set

Controls how Stripe applies the quantity.

  • Increment (default)
    Adds the quantity to existing usage for the period.
  • Set
    Replaces the usage value at that timestamp.

Increment is the standard and safest choice.

Usage timestamp

Defines when the usage occurred.

  • If empty, Stripe uses the current time.
  • If provided, it must be a Unix timestamp.

Quantity*

The amount of usage to record.

If not Found consider as

Success – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the Flow.

Failed – Wiresk treats this as an error or failure. The Flow stops or takes a predefined failure action.

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature (⚡ icon).

(*) required field

Name* Update Record
Connection* Select your connection or create one.
Entity*Payment links, Checkout session and Subscription.

Update a payment link.

Map Fields ⨁ Add Mapping

Active

Whether the payment link’s url is active. If false, customers visiting the URL will be shown a page saying that the link has been deactivated.

Line items*

The line items representing what is being sold. Each line item represents an item being sold. Up to 20 line items are supported.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first item.

Item ID*

The ID of an existing line item on the payment link.

  • Map it from a previous step (retrieve record payment link line items entity)
  • or manually provide it

Quantity*

Quantity if items.

⨁ Add Field

Allow adjust quantity: When set, provides configuration for this item’s quantity to be adjusted by the customer during checkout.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first adjustment.

Enable*

Set to true if the quantity can be adjusted to any non-negative Integer.

⨁ Add Field

Maximum quantity (Max 999999), default is 99.

Minimum quantity: By default this value is 0. If there is only one item in the cart then that item’s quantity cannot go down to 0.

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

After the purchase is complete

Action*

Choice:

Redirect to URL: Redirects the customer to the specified url after the purchase is complete. you must set Redirect config

Display a message: Displays a message on the hosted surface after the purchase is complete. You must set Hosted config.

Hosted configure

Custom message: Message to display

Redirect config

Redirect URL: The URL the customer will be redirected to after the purchase is complete.

Allow promotion codes

Whether user redeemable promotion codes are enabled.

Automatic tax

Configuration details for automatic tax collection.

If true, tax will be calculated automatically using the customer’s location.

Collecting billing address

Choices:

  • Auto: Checkout will only collect the billing address when necessary. When using automatic_tax, Checkout will collect the minimum number of fields required for tax calculation.
  • Required: Checkout will always collect the customer’s billing address.

Collecting consent

Payment method reuse agreement: Determines the display of payment method reuse agreement text in the UI. If set to hidden, it will hide legal text related to the reuse of a payment method.

  • auto
    • Uses Stripe defaults to determine the visibility and position of the payment method reuse agreement.
  • hidden
    • Hides the payment method reuse agreement.

Promotions: If set to auto, enables the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on the customer’s locale. Only available to US merchants.

  • auto
    • Enable the collection of customer consent for promotional communications. The Checkout Session will determine whether to display an option to opt into promotional communication from the merchant depending on if a customer is provided, and if that customer has consented to receiving promotional communications from the merchant in the past.
  • none
    • Checkout will not collect customer consent for promotional communications.

Terms of service: If set to required, it requires customers to check a terms of service checkbox before being able to pay. There must be a valid terms of service URL set in your Dashboard settings.

  • none
    • Does not display checkbox for the terms of service agreement.
  • required
    • Displays a checkbox for the terms of service agreement which requires customer to check before being able to pay.
⨁ Add Field

Price ID

The ID of the price object. You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item. Defaults to 1.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: The ID of the tax rate. You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

Custom Text

Display additional text for your customers using custom text.

After Submit: Custom text that should be displayed after the payment confirmation button.

Shipping Address: Custom text that should be displayed alongside shipping address collection.

Submit: Custom text that should be displayed alongside the payment confirmation button.

Terms Of Service Acceptance: Custom text that should be displayed in place of the default terms of service agreement text.

Customer Creation

Can only be used if the payment link does not contain any recurring prices.

Choices:

  • Always: The Checkout Session will always create a Customer when a Session confirmation is attempted.
  • If required: The Checkout Session will only create a Customer if it is required for Session confirmation. Currently, only subscription mode Sessions and payment mode Sessions with post-purchase invoices enabled require a Customer.

Inactive Message

The custom message to be displayed to a customer when a payment link is no longer active.

Restrictions

Settings that restrict the usage of a payment link.

Completed sessions* 

Count*: The current number of checkout sessions that have been completed on the payment link which count towards the completed_sessions restriction to be met.

Limite: The maximum number of checkout sessions that can be completed for the completed_sessions restriction to be met.

Shipping address collection

Configuration for collecting the customer’s shipping address.

Allowed countries

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Value*: Select a country name in a list.

Subscription data

When creating a subscription, the specified configuration data will be used. There must be at least one line item with a recurring price to use subscription_data.

Description: The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

Trial period days: Integer representing the number of trial period days before the customer is charged for the first time.

Trial settings: Settings related to subscription trials.

End behavior – Missing payment method:

  • Cancel: Cancel the subscription if a payment method is not attached when the trial ends.
  • Create invoice: Create an invoice when the trial ends, even if the user did not set up a payment method.
  • Pause: Pause the subscription if a payment method is not attached when the trial ends.

Matching Criteria

Record ID*

Unique identifier of the payment link. You can:

  • Select in the available list
  • or map it from a previous step

If not Found consider as

Success – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the Flow.

Failed – Wiresk treats this as an error or failure. The Flow stops or takes a predefined failure action.

Sample response 
{
  "id": "plink_1MoC3ULkdIwHu7ixZjtGpVl2",
  "object": "payment_link",
  "active": true,
  "after_completion": {
    "hosted_confirmation": {
      "custom_message": null
    },
    "type": "hosted_confirmation"
  },
  "allow_promotion_codes": false,
  "application_fee_amount": null,
  "application_fee_percent": null,
  "automatic_tax": {
    "enabled": false,
    "liability": null
  },
  "billing_address_collection": "auto",
  "consent_collection": null,
  "currency": "usd",
  "custom_fields": [],
  "custom_text": {
    "shipping_address": null,
    "submit": null
  },
  "customer_creation": "if_required",
  "invoice_creation": {
    "enabled": false,
    "invoice_data": {
      "account_tax_ids": null,
      "custom_fields": null,
      "description": null,
      "footer": null,
      "issuer": null,
      "metadata": {},
      "rendering_options": null
    }
  },
  "livemode": false,
  "metadata": {
    "order_id": "6735"
  },
  "on_behalf_of": null,
  "payment_intent_data": null,
  "payment_method_collection": "always",
  "payment_method_types": null,
  "phone_number_collection": {
    "enabled": false
  },
  "shipping_address_collection": null,
  "shipping_options": [],
  "submit_type": "auto",
  "subscription_data": {
    "description": null,
    "invoice_settings": {
      "issuer": {
        "type": "self"
      }
    },
    "trial_period_days": null
  },
  "tax_id_collection": {
    "enabled": false
  },
  "transfer_data": null,
  "url": "https://buy.stripe.com/test_cN25nr0iZ7bUa7meUY"
}
Expand

Update a subscription on an existing customer.

Map Fields ⨁ Add Mapping

items*

A list of up to 20 subscription items, each with an attached price.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first item.

Subscription item to update

ID of the Subscription item.

Billing Thresholds

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Usage gte*: Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

Price ID

The ID of the price object. One of price or price_data is required. When changing a subscription item’s price, quantity is set to 1 unless a quantity parameter is provided.

You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: ID of the tax rate

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

Cancel at period end

Indicate whether this subscription should cancel at the end of the current period (current_period_end). Defaults to false.

Default payment method

ID of the default payment method for the subscription. It must belong to the customer associated with the subscription. This takes precedence over default_source. If neither are set, invoices will use the customer’s invoice_settings.default_payment_method or default_source.

Description

The subscription’s description, meant to be displayable to the customer. Use this field to optionally store an explanation of the subscription for rendering in Stripe surfaces and certain local payment methods UIs.

The maximum length is 500 characters.

Metadata

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.

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Keys and values are stored as strings and can contain any characters with one exception: you can’t use square brackets ([ and ]) in keys.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first pair.

Key*

Value*

Payment behavior

Use allow_incomplete to transition the subscription to status=past_due if a payment is required but cannot be paid. This allows you to manage scenarios where additional user actions are needed to pay a subscription’s invoice. For example, SCA regulation may require 3DS authentication to complete payment. See the SCA Migration Guide for Billing to learn more. This is the default behavior.

Use default_incomplete to transition the subscription to status=past_due when payment is required and await explicit confirmation of the invoice’s payment intent. This allows simpler management of scenarios where additional user actions are needed to pay a subscription’s invoice. Such as failed payments, SCA regulation, or collecting a mandate for a bank debit payment method.

Use pending_if_incomplete to update the subscription using pending updates. When you use pending_if_incomplete you can only pass the parameters supported by pending updates.

Use error_if_incomplete if you want Stripe to return an HTTP 402 status code if a subscription’s invoice cannot be paid. For example, if a payment method requires 3DS authentication due to SCA regulation and further user action is needed, this parameter does not update the subscription and returns an error instead. This was the default behavior for API versions prior to 2019-03-14. See the changelog to learn more.

Add invoice items

A list of prices and quantities that will generate invoice items appended to the next invoice for this subscription. You may pass up to 20 items.

⨁ Add Field

Price ID

The ID of the price object. You can:

  • Use the lookup feature. Go to default value>search
  • Map the ID from a previous step

Quantity

Quantity for this item. Defaults to 1.

Tax rates

A list of Tax Rate ids. These Tax Rates will override the default_tax_rates on the Subscription. When updating, pass an empty string to remove previously-defined tax rates.

⨁ Element ⨁ Map
(Add a repeating group of fields or Map it from an array. See Field Mapping).

Element 1: Represents the first rate.

Tax rate*: The ID of the tax rate. You can:

  • Map the ID from a previous step
  • Use the lookup feature. Go to default value>search

Automatic tax

Enabled automatic tax calculation which will automatically compute tax rates on all invoices generated by the subscription.

Billing cycle anchor

Either now or unchanged. Setting the value to now resets the subscription’s billing cycle anchor to the current time (in UTC). For more information, see the billing cycle documentation.

Billing Tresholds

Define thresholds at which an invoice will be sent, and the subscription advanced to a new billing period. Pass an empty string to remove previously-defined thresholds.

Usage gte: Number of units that meets the billing threshold to advance the subscription to a new billing period (e.g., it takes 10 $5 units to meet a $50 monetary threshold)

Reset billing cycle anchor: Indicates if the billing_cycle_anchor should be reset when a threshold is reached. If true, billing_cycle_anchor will be updated to the date/time the threshold was last reached; otherwise, the value will remain unchanged.

Cancel at

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.

Collection method

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 and mark the subscription as active. Defaults to charge_automatically.

Coupon ID

ID of the coupon to create a new discount for.

Day until due

Number of days a customer has to pay invoices generated by this subscription. Valid only for subscriptions where collection_method is set to send_invoice.

Default tax rates

The tax rates that will apply to any subscription item that does not have tax_rates set. Invoices created will have their default_tax_rates populated from the subscription. Pass an empty string to remove previously-defined tax rates.

Off session

Indicates if a customer is on or off-session while an invoice payment is attempted. Defaults to false (on-session).

Pending invoice item interval

Specifies an interval for how often to bill for any pending invoice items. It is analogous to calling Create an invoice for the given subscription at the specified interval.

Interval*: Specifies invoicing frequency. Either day, week, month or year.

Interval count: The number of intervals between invoices. 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).

Proration date

If set, prorations will be calculated as though the subscription was updated at the given time. This can be used to apply exactly the same prorations that were previewed with the create preview endpoint. proration_date can also be used to implement custom proration logic, such as prorating by day instead of by second, by providing the time that you wish to use for proration calculations.

Promotion Code

ID of the promotion code to create a new discount for.

Proration behavior

Determines how to handle prorations when the billing cycle changes (e.g., when switching plans, resetting billing_cycle_anchor=now, or starting a trial), or if an item’s quantity changes. The default value is create_prorations.

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 billing_cycle_anchor will be updated to the trial_end value. The special value now can be provided to end the customer’s trial immediately. Can be at most two years from billing_cycle_anchor.

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. See Using trial periods on subscriptions to learn more.

Trial settings

Settings related to subscription trials.

End behavior – Missing payment method:

  • Cancel: Cancel the subscription if a payment method is not attached when the trial ends.
  • Create invoice: Create an invoice when the trial ends, even if the user did not set up a payment method.
  • Pause: Pause the subscription if a payment method is not attached when the trial ends.

Cancellation details

Comment: Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.

Feedback: The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user:

  • customer_service: Customer service was less than expected
  • low_quality: Quality was less than expected
  • missing_features: Some features are missing
  • other: Other reason
  • switched_service: I’m switching to a different service
  • too_complex: Ease of use was less than expected
  • too_expensive: It’s too expensive
  • unused: I don’t use the service enough

Matching criteria

Record ID*

Unique identifier of the subscription.

  • Map the ID from a previous step
  • Select in list

If not Found consider as

Success – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the Flow.

Failed – Wiresk treats this as an error or failure. The Flow stops or takes a predefined failure action.

Sample response

Configuration Table:

Input Options (Field Mapping):

  • Input: Allows dynamic inputs, e.g., from a Trigger or from Step responses. Input tab>uncheck “Show recommended” to see all fields).
  • Default Value: Select value from a defined list or specify a fixed attribute.
  • Manual input: Set a custom value by using the Lightning Bold feature (⚡ icon).

(*) required field

Name* Get Customer
Connection* Select your connection or create one.
Entity*Stripe entity to query: Payment links, Payment link Line Items, Checkout session and Subscription.

Matching Criteria

Search Keyword*

You can search by:

  • Name
  • Email
  • Phone

If not Found consider as

Success – When the record is not found during execution, the system does not treat this as an error. Instead, it considers the operation successful and continues with the Flow.

Failed – Wiresk treats this as an error or failure. The Flow stops or takes a predefined failure action.

Customer object 
{
  "id": "cus_NffrFeUfNV2Hib",
  "object": "customer",
  "address": null,
  "balance": 0,
  "created": 1680893993,
  "currency": null,
  "default_source": null,
  "delinquent": false,
  "description": null,
  "email": "jennyrosen@example.com",
  "invoice_prefix": "0759376C",
  "invoice_settings": {
    "custom_fields": null,
    "default_payment_method": null,
    "footer": null,
    "rendering_options": null
  },
  "livemode": false,
  "metadata": {},
  "name": "Jenny Rosen",
  "next_invoice_sequence": 1,
  "phone": null,
  "preferred_locales": [],
  "shipping": null,
  "tax_exempt": "none",
  "test_clock": null
}
Expand

Once your Flow is configured, you can test or automate it using the Run panel or by managing Triggers from the Flow Management screen.

  • Run Flow: Manually runs the Flow once using sample data. Ideal for testing logic and field mapping. See How to Run a Flow.
  • Run Scheduler: Force-runs the Trigger immediately using live input. This bypasses the recurrence rule and is useful for verifying real data mapping. Learn more in Wiresk Scheduler – The Fundamentals.

From the Trigger management panel (clock icon), you can:

  • Activate or deactivate Triggers
  • Force-run the scheduler
  • Copy Routing Keys (for HTTP Triggers)

If your Flow uses a Webhook Trigger, it runs automatically on each incoming webhook—no scheduler required. It remains active until you manually deactivate it.