PricingPlanSubscription event types v2

This is a list of all public thin events we currently send for updates to PricingPlanSubscription, which are continually evolving and expanding. The payload of thin events is unversioned. During processing, you must fetch the versioned event from the API or fetch the resource’s current state.

Event types

Type

Filter events by type

Type

v2.billing.pricing_plan_subscription.collection_awaiting_customer_action

Occurs when a PricingPlanSubscription's collection is awaiting customer action.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_awaiting_customer_action",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_current

Occurs when a PricingPlanSubscription's collection is current.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_current"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_current",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_past_due

Occurs when a PricingPlanSubscription's collection is past due.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_past_due"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_past_due",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_paused

Occurs when a PricingPlanSubscription's collection is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.collection_unpaid

Occurs when a PricingPlanSubscription's collection is unpaid.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.collection_unpaid"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.collection_unpaid",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_activated

Occurs when PricingPlanSubscription servicing is activated.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_activated"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_activated",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_canceled

Occurs when PricingPlanSubscription servicing is canceled.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_canceled"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_canceled",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

v2.billing.pricing_plan_subscription.servicing_paused

Occurs when PricingPlanSubscription servicing is paused.

Attributes

idstring
Unique identifier for the event.

objectstring, value is "v2.core.event"
String representing the object’s type. Objects of the same type share the same value of the object field.

contextnullable string
Authentication context needed to fetch the event or related object.

createdtimestamp
Time at which the object was created.

livemodeboolean
Has the value true if the object exists in live mode or the value false if the object exists in test mode.

reasonnullable object
Reason for the event.

related_objectnullable object
Object containing the reference to API resource relevant to the event.

typestring, value is "v2.billing.pricing_plan_subscription.servicing_paused"
The type of the event.

Fetched attributes

dataobject
Additional data about the event.

Event payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  }
}

Event handler

Server-side language

# Select a client library to see examples of
# parsing and retrieving event details.

Fetched payload

{
  "created": "2025-01-01T00:00:00.000Z",
  "id": "evt_65SJgXYCjW0tI4frH0Z16RuKJoESSQUtPVJKIgeI4D29yV",
  "object": "v2.core.event",
  "type": "v2.billing.pricing_plan_subscription.servicing_paused",
  "livemode": true,
  "related_object": {
    "id": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
    "type": "v2.billing.pricing_plan_subscription",
    "url": "/v2/billing/pricing_plan_subscriptions/bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
  },
  "data": {}
}

Quote

A Quote is a way to model prices that you’d like to provide to a customer. Once accepted, it will automatically create an invoice, subscription or subscription schedule.

Endpoints

POST/v1/quotes

POST/v1/quotes/:id

GET/v1/quotes/:id/line_items

GET/v1/quotes/:id/computed_upfront_line_items

GET/v1/quotes/:id

GET/v1/quotes

POST/v1/quotes/:id/accept

POST/v1/quotes/:id/cancel

GET/v1/quotes/:id/pdf

POST/v1/quotes/:id/finalize