Skip to content

Commit

Permalink
Add more docs for stripe interpot subscriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
that-guy-iain committed Dec 2, 2023
1 parent bba3bb5 commit f17d365
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions docs/technical/interoptability/stripe/subscriptions.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_position: 1
---
The Stripe Subscription Interopability layer is to allow you to continue using the same code you're using to create subscriptions using Stripe Billing.

## List
## List - GET - v1/subscriptions/

### Parameters

Expand All @@ -22,4 +22,15 @@ The Stripe Subscription Interopability layer is to allow you to continue using t
| ending_before | yes | 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. |
| limit | yes | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10. |
| starting_after | yes | 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. |
| test_clock | no | Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. |
| test_clock | no | Filter for subscriptions that are associated with the specified test clock. The response will not include subscriptions with test clocks if this and the customer parameter is not set. |

## Cancel - DELETE - v1/subscriptions/

### Request Body Parameters

| Name | Supported | Description |
| --- | --- | --- |
| invoice_now | no | Will generate a final invoice that invoices for any un-invoiced metered usage and new/pending proration invoice items. |
| prorate | yes | Will generate a proration invoice item that credits remaining unused time until the subscription period end. |
| cancellation_details.comment | yes | Additional comments about why the user canceled the subscription, if the subscription was canceled explicitly by the user.
| cancellation_details.feedback | no | The customer submitted reason for why they canceled, if the subscription was canceled explicitly by the user. |

0 comments on commit f17d365

Please sign in to comment.