All Collections
Wrk Action Library
Stripe
Retrieve subscription details from Stripe
Retrieve subscription details from Stripe
Wrk Product avatar
Written by Wrk Product
Updated over a week ago

Retrieves details of a subscription from Stripe.

Application

  • Stripe

Inputs (what you have)

Name

Description

Data Type

Required?

Example

Subscription ID

Identifier for the subscription.

Text(Short)

Yes

sub_1N6Lzj2eZvKYlo2COh0sxkrv

Note: the value of inputs can either be a set value in the configuration of the Wrk Action within the Wrkflow, or a variable from the Data library section. These variables in the Data library section are the outputs of previous Wrk Actions in the Wrkflow.


Outputs (what you get)

Name

Description

Data Type

Required?

ID

ID of the subscription

Text (Short)

Yes

Object

Type of the object

Text (Short)

Yes

Application

ID of the Connect Application

Text (Short)

Yes

Application fee percent

Percentage of subscription invoice subtotal transferred

Number

Yes

Billing cycle anchor

First full invoice date and subsequent invoice day

Date & Time

Yes

Cancel at

Date of automatic cancellation

Date & Time

Yes

Cancel at period end

Scheduled cancellation at the end of the period

True or False

Yes

Canceled at

Date of subscription cancellation

Date & Time

Yes

Cancellation comment

Additional comments about why the user canceled the subscription

Text (Long)

Yes

Cancellation feedback

The customer submitted reason for why they cancelled

Text (Short)

Yes

Cancellation reason

Why this subscription was cancelled.

Text (Short)

Yes

Collection method

Method for collecting payment

Text (Short)

Yes

Created

Timestamp of creation

Date & Time

Yes

Currency

Currency used for the subscription

Text (Short)

Yes

Current period end

End date of the current invoiced period

Date & Time

Yes

Current period start

Start date of the current invoiced period

Date & Time

Yes

Customer ID

ID of the customer who owns the subscription

Text (Short)

Yes

Days until due

Number of days to pay invoices generated by the subscription

Integer

Yes

Default payment method

ID of the default payment method

Text (Short)

Yes

Default source

ID of the default payment source

Text (Short)

Yes

Default tax rates active

Active default tax rates

True or False

Yes

Default tax rates country

Country of default tax rates

Text (Short)

Yes

Default tax rates created

Creation timestamp of default tax rates

Date & Time

Yes

Default tax rates description

Description of default tax rates

Text (Short)

Yes

Default tax rates display name

Display name of default tax rates

Text (Short)

Yes

Default tax rates effective percentage

Effective percentage of default tax rates

Number

Yes

Default tax rates ID

ID of the default tax rates

Text (Short)

Yes

Default tax rates inclusive

Inclusiveness of default tax rates

True or False

Yes

Default tax rates jurisdiction

Jurisdiction of default tax rates

Text (Short)

Yes

Default tax rates livemode

Whether default tax rates are in live mode

True or False

Yes

Default tax rates object

Type of default tax rates

Text (Short)

Yes

Default tax rates percentage

Percentage of default tax rates

Number

Yes

Default tax rates state

State of default tax rates

Text (Short)

Yes

Default tax rates tax type

Type of tax for default tax rates

Text (Short)

Yes

Description

Description of the subscription

Text (Short)

Yes

Ended at

End date of the subscription

Date & Time

Yes

Latest invoice

ID of the most recent invoice

Text (Short)

Yes

Livemode

Whether the subscription is in live mode

True or False

Yes

Next pending invoice item invoice

Next pending invoice item invoice

Date & Time

Yes

On behalf of

ID of the account the charge was made on behalf of

Text (Short)

Yes

Pending setup intent

ID of the pending setup intent

Text (Short)

Yes

Schedule

Schedule attached to the subscription

Text (Short)

Yes

Start date

Start date of the subscription

Date & Time

Yes

Status

Status of the subscription

Text (Short)

Yes

Test clock

ID of the test clock

Text (Short)

Yes

Trial end

End date of the trial period

Date & Time

Yes

Trial start

Start date of the trial period

Date & Time

Yes


โ€‹

Outcomes

Name

Description

Success

This status is selected when details are found for the description

No Result

This status is selected in the event of the following scenarios:

  • No result can be found for the subscription ID provided

Impossible to Complete

This status is selected in the event of the following scenarios:

  • The external system is not accessible

  • Unable to access with the provided credentials

Requirements

  • N/A

Did this answer your question?