The IntentAction object 

Billing
Billing Intents
The IntentAction object

Attributes

  • idstring

    Unique identifier for the object.

  • objectstring, value is "v2.billing.intent_action"

    String representing the object’s type. Objects of the same type share the same value of the object field.

  • createdtimestamp

    Time at which the object was created.

  • deactivatenullable object

    Details for a deactivate action.

    • deactivate.typeenum

      Type of the action details.

      Possible enum values
      pricing_plan_subscription_details

      Action details for a pricing plan subscription.

  • livemodeboolean

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

  • modifynullable object

    Details for a modify action.

    • modify.typeenum

      Type of the action details.

      Possible enum values
      pricing_plan_subscription_details

      Action details for a pricing plan subscription.

  • subscribenullable object

    Details for a subscribe action.

    • subscribe.typeenum

      Type of the action details.

      Possible enum values
      pricing_plan_subscription_details

      Action details for a pricing plan subscription.

  • typeenum

    Type of the Billing Intent Action.

    Possible enum values
    deactivate

    Action to deactivate an existing subscription.

    modify

    Action to modify an existing subscription.

    subscribe

    Action to create a new subscription.

The IntentAction object
{
"created": "2025-01-01T00:00:00.000Z",
"id": "bilinti_61T9VNT6aGFjxfNPx16SBbsMNLSQJnWcho4VDz0fYVOq",
"object": "v2.billing.intent_action",
"type": "subscribe",
"livemode": true,
"subscribe": {
"type": "pricing_plan_subscription_details",
"pricing_plan_subscription_details": {
"component_configurations": [],
"metadata": {},
"pricing_plan": "bpp_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
"pricing_plan_version": "bppv_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy",
"pricing_plan_subscription": "bpps_61SbQ4ZVMJ2ESqq2416S40x4RVA8P2F2ShZStd6x6RCy"
}
}
}