Update API v2 OpenAPI Specifications #213
Conversation
|
Preview this PR here: https://dev-docs.revenuecat.com/pr-213/ |
| description: The ID of the customer | ||
| description: The id of the customer |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: The ID of the original customer. Relevant for subscriptions | ||
| that were transferred from one customer to another | ||
| description: The id of the original customer |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: The RevenueCat ID of the product that the customer is subscribed | ||
| to | ||
| description: The ID of the product that the customer is subscribed to |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: The date when the subscription billing period is expected to | ||
| end in ms since epoch. Can be null if the subscription is paused until | ||
| an indefinite date. | ||
| description: The date when the subscription billing period ends in ms since | ||
| epoch. Can be null if the subscription is paused until an indefinite date. |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: "The auto renewal status of a subscription.<br><br>Possible\ | ||
| \ values:<br>\u2022 `will_renew`: the subscription is currently set to\ | ||
| \ automatically renew<br>\u2022 `will_not_renew`: the subscription is\ | ||
| \ currently set to expire at the end of the period<br>\u2022 `will_change_product`:\ | ||
| \ the subscription is currently set to change product at the end of the\ | ||
| \ period (which might start a new subscription)<br>\u2022 `will_pause`:\ | ||
| \ the subscription is currently set to pause at the end of the current\ | ||
| \ period<br>\u2022 `requires_price_increase_consent`: the subscription\ | ||
| \ will expire at the end of the current period unless the customer consents\ | ||
| \ to the price increase<br>\u2022 `has_already_renewed`: the customer\ | ||
| \ has already been charged for the upcoming renewal (so the renewal will\ | ||
| \ take place even if the customer opts out of auto-renewal before the\ | ||
| \ end of the period) \n" | ||
| description: The auto renewal status of a subscription |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: "The status of a subscription. Please note that additional\ | ||
| \ states might be added in the future. To determine whether or not a subscription\ | ||
| \ currently provides access to any associated entitlements, use the\_\ | ||
| gives_access\_field.<br><br>Possible values:<br>\u2022 `trialing`: the\ | ||
| \ subscription is in a free trial period<br>\u2022 `active`: the subscription\ | ||
| \ is active, in a paid period<br>\u2022 `expired`: the subscription is\ | ||
| \ expired and no longer active<br>\u2022 `in_grace_period`: the subscription\ | ||
| \ is past its regular expiry date and experienced a billing issue, but\ | ||
| \ is currently still in an access-granting grace period<br>\u2022 `in_billing_retry`:\ | ||
| \ the subscription has experienced a billing issue. Billing is being retried,\ | ||
| \ access is suspended.-paused: the subscription is currently paused and\ | ||
| \ should not provide access.<br>\u2022 `unknown`: the subscription is\ | ||
| \ in an unknown state. Refer to the gives_access field to determine whether\ | ||
| \ or not to grant access.\n" | ||
| description: The status of a subscription |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: The subscription identifier as per the store (e.g, for Apple | ||
| App Store, the `transaction_id`` of the latest transaction of the subscription, | ||
| or for Google Play Store, the Order ID of the last renewal of the subscription) | ||
| description: The store subscription identifier |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
| description: Indicates pending product changes. Present if the `auto_renewal_status` | ||
| is `will_change_product`. | ||
| description: Details about the pending object |
There was a problem hiding this comment.
would be good to keep the version currently in the docusaurus repo here (more extensive documentation)
|
Closing this in favor of a new try with the latest khepri updates: https://github.com/RevenueCat/khepri/pull/8730 |
Auto-generated PR to update API v2 OpenAPI specs