Appearance
abacatepay.subscription.start ​
Ensure recurring product + customer, create subscription, await activation.
Overview ​
| Property | Value |
|---|---|
| Workflow type | Dag |
| Library | App-abacatepay |
| Version | 1.0 |
Input Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
workflow_run_id | string | No | — | — |
product | json | Yes | — | — |
customer | json | No | — | — |
customer_ref | string | No | — | — |
quantity | integer | No | — | — |
methods | list | No | — | — |
return_url | string | No | — | — |
completion_url | string | No | — | — |
external_id | string | No | — | — |
metadata | json | No | — | — |
Output Schema ​
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
organization_uuid | uuid | Yes | — | — |
cloud_connection_uuid | uuid | Yes | — | — |
workflow_run_id | string | No | — | — |
product_ref | string | Yes | — | — |
customer_ref | string | No | — | — |
subscription_ref | string | Yes | — | — |
checkout_url | string | Yes | — | — |
status | string | Yes | — | — |
active | boolean | Yes | — | — |
failure_reason | string | No | — | — |
failure_type | string | No | — | — |
failed_action | string | No | — | — |
failed_step | json | No | — | — |
failed_layer | integer | No | — | — |
failed_at_state | string | No | — | — |
error | string | No | — | — |
error_type | string | No | — | — |
failed_at | string | No | — | — |
provider_request_ref | string | No | — | — |
retryable | boolean | No | — | — |
ensure_product | json | No | — | — |
ensure_customer | json | No | — | — |
create_subscription | json | No | — | — |
await_activation | json | No | — | — |
product | json | Yes | — | — |
customer | json | No | — | — |
quantity | integer | No | — | — |
methods | list | No | — | — |
return_url | string | No | — | — |
completion_url | string | No | — | — |
external_id | string | No | — | — |
metadata | json | No | — | — |
DAG Layers ​
| # | Layer | Steps | Compensation |
|---|---|---|---|
| 1 | ensure | abacatepay.catalog.ensure-product, abacatepay.customer.ensure | — |
| 2 | subscribe | abacatepay.subscription.create | — |
| 3 | await | abacatepay.subscription.await-activation | — |
Execution Flow ​
Sub-workflows ​
| Sub-workflow | Step name |
|---|---|
abacatepay.catalog.ensure-product | ensure_product |
abacatepay.customer.ensure | ensure_customer |
abacatepay.subscription.create | create_subscription |
abacatepay.subscription.await-activation | await_activation |
API Usage ​
bash
POST /api/workflows/start
Content-Type: application/json
{
"workflow_type": "abacatepay.subscription.start",
"initial_data": {
"organization_uuid": "value",
"cloud_connection_uuid": "value",
"product": "value"
}
}