Ir al contenido

Restaurant - Subscription

Update a subscription

PATCH
/restaurant/subscriptions/{id}
curl --request PATCH \
--url https://api.inspow.tech/api/v1/restaurant/subscriptions/example \
--header 'Content-Type: application/json' \
--data '{ "user": "645cc3d3f8a9c9a2b88a22c1", "beneficiary": "645cc3d3f8a9c9a2b88a22c2", "requireParentConfirm": false, "plan": "645cc3d3f8a9c9a2b88a22c3", "startDate": "next day", "endDate": "2025-05-31T23:59:59.999Z", "status": "draft", "autoRenew": true, "billingInterval": "minute", "billingIntervalCount": 2, "cancellationReason": "Usuario solicitó cancelación", "suspensionReason": "Problemas de pago", "metadata": { "source": "mobile_app", "campaign": "summer2025" }, "createdBy": "645cc3d3f8a9c9a2b88a22c4", "updatedBy": "645cc3d3f8a9c9a2b88a22c5" }'
id
required
string
Media type application/json
object
user

The ID of the user associated with the subscription (quien paga).

string
Example
645cc3d3f8a9c9a2b88a22c1
beneficiary

The ID of the beneficiary (hijo). Omitir para suscripción individual.

string
Example
645cc3d3f8a9c9a2b88a22c2
requireParentConfirm

If true, parental confirmation is required before activating the subscription.

boolean
Example
false
plan

The ID of the plan contratado.

string
Example
645cc3d3f8a9c9a2b88a22c3
startDate

Subscription start date.

string format: date-time
default: next day
Example
2025-05-01T00:00:00.000Z
endDate

Subscription end date.

string format: date-time
Example
2025-05-31T23:59:59.999Z
status

Estado inicial de la suscripción.

string
default: pending_payment
Allowed values: draft pending_parent_confirmation pending_payment active suspended cancelled expired
Example
pending_payment
autoRenew

If true, the subscription will automatically renew.

boolean
default: true
Example
true
billingInterval

Override billing interval from plan (for testing purposes)

string
Allowed values: minute hour day week month year
Example
minute
billingIntervalCount

Override billing interval count from plan (for testing purposes)

number
Example
2
cancellationReason

Razón de cancelación (solo si se crea ya cancelada).

string
Example
Usuario solicitó cancelación
suspensionReason

Razón de suspensión (solo si se crea suspendida).

string
Example
Problemas de pago
metadata

Metadata adicional para la suscripción.

object
Example
{
"source": "mobile_app",
"campaign": "summer2025"
}
createdBy

User who created this record.

string format: MongoId
Example
645cc3d3f8a9c9a2b88a22c4
updatedBy

User who last updated this record.

string format: MongoId
Example
645cc3d3f8a9c9a2b88a22c5