dodopayments 2.48.0 → 2.50.0

package/src/resources/subscriptions.ts

@@ -526,6 +526,12 @@ export interface Subscription {
    */
   customer: PaymentsAPI.CustomerLimitedDetails;
 
+  /**
+   * Whether a payment method is on file. False while a card-optional subscription
+   * waits for the customer to add one.
+   */
+  has_payment_method: boolean;
+
   /**
    * Additional custom data associated with the subscription
    */
@@ -695,7 +701,8 @@ export type SubscriptionStatus =
   | 'paused'
   | 'cancelled'
   | 'failed'
-  | 'expired';
+  | 'expired'
+  | 'past_due';
 
 /**
  * Unit of a duration count (e.g. license-key validity period).
@@ -822,6 +829,12 @@ export interface SubscriptionCreateResponse {
    */
   payment_id: string;
 
+  /**
+   * False when the customer can start this subscription with no card. True for every
+   * other subscription.
+   */
+  payment_method_required: boolean;
+
   /**
    * Tax will be added to the amount and charged to the customer on each billing
    * cycle
@@ -913,6 +926,12 @@ export interface SubscriptionListResponse {
    */
   discounts: Array<SubscriptionListResponse.Discount>;
 
+  /**
+   * Whether a payment method is on file. False while a card-optional subscription
+   * waits for the customer to add one.
+   */
+  has_payment_method: boolean;
+
   /**
    * Additional custom data associated with the subscription
    */
@@ -1392,7 +1411,7 @@ export interface SubscriptionListParams extends DefaultPageNumberPaginationParam
   /**
    * Filter by status
    */
-  status?: 'pending' | 'active' | 'on_hold' | 'paused' | 'cancelled' | 'failed' | 'expired';
+  status?: 'pending' | 'active' | 'on_hold' | 'paused' | 'cancelled' | 'failed' | 'expired' | 'past_due';
 }
 
 export interface SubscriptionCreateParams {
@@ -1548,6 +1567,7 @@ export interface SubscriptionUpdateParams {
     | 'cancelled_by_customer'
     | 'cancelled_by_merchant'
     | 'cancelled_by_merchant_send_dunning'
+    | 'cancelled_by_merchant_grace_period_expired'
     | 'dodo_team'
     | null;
 

package/src/resources/webhook-events.ts

@@ -32,6 +32,7 @@ export type WebhookEventType =
   | 'subscription.active'
   | 'subscription.renewed'
   | 'subscription.on_hold'
+  | 'subscription.past_due'
   | 'subscription.paused'
   | 'subscription.unpaused'
   | 'subscription.cancelled'
@@ -105,6 +106,17 @@ export namespace WebhookPayload {
    */
   export interface Subscription extends SubscriptionsAPI.Subscription {
     payload_type: 'Subscription';
+
+    /**
+     * Time when the grace period ends. The subscription moves to `on_hold` or to
+     * `cancelled` at this time.
+     *
+     * Read in the same query as the rest of the payload, so it always comes from the
+     * row snapshot that produced `status`. It is set whenever the subscription sits in
+     * a window at that moment. A delayed event of another type therefore carries the
+     * deadline too, next to a `past_due` status.
+     */
+    past_due_ends_at?: string | null;
   }
 
   export interface Refund extends RefundsAPI.Refund {
@@ -270,7 +282,7 @@ export namespace WebhookPayload {
 
     subscription_id: string;
 
-    trigger_state: 'on_hold' | 'cancelled';
+    trigger_state: 'on_hold' | 'cancelled' | 'past_due';
 
     payment_id?: string | null;
   }

package/src/resources/webhooks/index.ts

@@ -46,6 +46,7 @@ export {
   type SubscriptionExpiredWebhookEvent,
   type SubscriptionFailedWebhookEvent,
   type SubscriptionOnHoldWebhookEvent,
+  type SubscriptionPastDueWebhookEvent,
   type SubscriptionPausedWebhookEvent,
   type SubscriptionPlanChangedWebhookEvent,
   type SubscriptionRenewedWebhookEvent,