Skip to main content
POST
Send a scheduled bill now

Authorizations

Authorization
string
header
required

A Dueflow access token: dfp_ (personal) or dfs_ (service). Permissions are the token's scopes intersected with the role ceiling, re-evaluated per request.

Scopes

payments:write

Headers

Idempotency-Key
string
required

A unique key per logical operation, e.g. a UUID. Keys are remembered for 24 hours per token: a retry within that window with the same key replays the original response (marked Idempotent-Replayed: true) instead of repeating the write; reusing a key with different parameters is a 409.

Maximum string length: 255

Path Parameters

paymentId
string
required

Body

application/json

The body is of type object.

Response

Success

id
string
required
memberId
string | null
required
groupId
string | null
required
targetOrganizationId
string | null
required
description
string
required
amount
string
required
paidToDate
string
required
currency
string
required
status
enum<string>
required
Available options:
pending,
processing,
partially_paid,
paid,
cancelled,
failed,
disputed
dueDate
string | null
required
paidAt
string<date-time> | null
required

Timestamp: RFC 3339, UTC, millisecond precision (2026-01-31T17:04:05.123Z).

voidedAt
string<date-time> | null
required

Timestamp: RFC 3339, UTC, millisecond precision (2026-01-31T17:04:05.123Z).

scheduledSendAt
string<date-time> | null
required

When the bill email is scheduled to go out. Null when it went out at creation or was sent early. A future time means the bill is held: the member gets no email or reminders until then.

createdAt
string<date-time>
required

Timestamp: RFC 3339, UTC, millisecond precision (2026-01-31T17:04:05.123Z).

updatedAt
string<date-time>
required

Timestamp: RFC 3339, UTC, millisecond precision (2026-01-31T17:04:05.123Z).

delivery
enum<string>
required
Available options:
sent,
already_sending