Assign Profile

POST

/api/:account_id/dunning/profiles/:profile_id/assignments

Assign a dunning profile to a cycle length or price.

This determines which profile is used when dunning starts for a subscription.

Resolution order:

Price-level assignment (if subscription has a price with an assignment)
Cycle-length assignment (based on subscription’s billing cycle)
System default profile (always available as fallback)

resource_type values:

“cycle_length”: Assign to a billing cycle range. resource_id must be “daily”, “short”, “medium”, or “long”.
“price”: Assign to a specific price. resource_id is the price’s ID. Overrides the cycle-length assignment for that price.

If an assignment already exists for the same (resource_type, resource_id), it will be replaced with this profile.

Assign a dunning profile to a cycle length or price. This determines which profile is used when dunning starts for a subscription. Resolution order: 1. Price-level assignment (if subscription has a price with an assignment) 2. Cycle-length assignment (based on subscription's billing cycle) 3. System default profile (always available as fallback) resource_type values: - "cycle_length": Assign to a billing cycle range. resource_id must be "daily", "short", "medium", or "long". - "price": Assign to a specific price. resource_id is the price's ID. Overrides the cycle-length assignment for that price. If an assignment already exists for the same (resource_type, resource_id), it will be replaced with this profile.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

profile_idstringRequired

account_idstringRequired

Request

This endpoint expects an object.

resource_typeenumRequired

Type of resource to assign to: ‘cycle_length’ or ‘price’

resource_idstringRequired

For cycle_length: ‘daily’, ‘short’, ‘medium’, ‘long’. For price: the price’s ID

Response

Successful Response

idstring

profile_idstring

resource_typestring

resource_idstring

assigned_atdatetime

Errors

422

Unprocessable Entity Error

$	curl -X POST https://app.paymentkit.com/api/account_id/dunning/profiles/profile_id/assignments \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"resource_type": "cycle_length",
>	"resource_id": "medium"
>	}'

1	{
2	"id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
3	"profile_id": "profile_987654321",
4	"resource_type": "cycle_length",
5	"resource_id": "medium",
6	"assigned_at": "2024-01-15T09:30:00Z"
7	}