Subscription fields

FIELD	DATATYPE	REQUEST	RESPONSE	SIZE	DESCRIPTION
subscriptionId	String	-	(M)	36	The unique identifier of the subscription. Format UUID.
planId	String	(M)	-	36	The unique identifier of the plan. Format UUID.
currency	String	(M)	-	3	Currency in which you want the recurrences to be charged. This currency must be correctly configured in the backoffice. It must use the code in ISO 4217 format
eventSubscriptionUrl	String	(M)	-	Unlimited (BD 400KB)	The URL to which any subscription changes an event will be sent. Valid URI
overwrite.initialAmount	BigDecimal	(O)	-	38	If present, the initial subscription amount will be overwritten by the specified amount. All other recurring payments will respect the values specified by the plan. If not present, the plan amounts will be charged.

CANCEL FIELDS
reason	String	-	(M)	50	Reason of the cancellation, possible values: end_plan: The subscription is canceled because it reaches the end of the plan hard_decline: The subscription is canceled because we received a hard decline from the PSP merchant_api: The subscription is canceled by a merchant API request backoffice_api: The subscription is canceled from our BO dispute: The subscription is canceled by Chargeback or RDR and the plan is set to auto cancel
cancellationDetail	String	(O)	(O)	25	Short description about the cancellation reason
cancellation.reason	String (Enum)	-	(O)	20	Cancellation reason of the subscription. This field admits the following values: end_plan: The subscription is canceled because it reaches the end of the plan hard_decline: The subscription is canceled because we received a hard decline from the PSP merchant_api: The subscription is canceled by a merchant API request backoffice_api: The subscription is canceled from our BO dispute: The subscription is canceled by Chargeback or RDR and the plan is set to auto cancel
cancellation.detail	String	(O)	(O)	25	Short description about the cancellation reason
cancellation.requestedAt	Instant	-	(O)	20	The date and time when a subscription is cancelled in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.

EVENTS FIELDS
eventId	String	-	(M)	36	The unique identifier of the event. Format UUID.
eventType	String (Enum)	-	(M)	50	Event type. This field admits the following values: subscription.created subscription.archived subscription.updated subscription.cancelled subscription.payment.refunded subscription.paused subscription.resumed subscription.payment.disputed
occurredAt	Instant	-	(M)	20	The date and time when an event is sent in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.
originator.type	String (Enum)	-	(M)	50	The type of the originator that made the event. This field admits the following values: payment merchant backoffice payment_refunded payment_disputed cancellation_settings
originator.data.paymentId	String	-	(O)	36	The unique identifier of the payment. Format UUID. Only mandatory when a payment is the originator.
originator.data.orderId	String	-	(O)	36	The unique identifier of the order. Format UUID. Only mandatory when a payment is the originator.
originator.data.type	String (Enum)	-	(O)	50	The type of originator payment. Only mandatory when a payment is the originator. This field admits the following values: initial renewal maintenance end_of_billing_cycle
originator.data.reason	String	-	(O)	50	The cancellation settings reason.
originator.data.status	String (Enum)	-	(O)	50	The status of originator payment. Only mandatory when a payment is the originator. This field admits the following values: accepted failed pending paying archived paused
originator.data.cycle	Integer	-	(O)	3	The number of the originator cycle
originator.data.attempt	Integer	-	(O)	3	The number of the payment attempt. Only mandatory when a payment is the originator.
originator.data.money.amount	BigDecimal	-	(O)	38	The amount of the transaction. The amount of the decimal place depends on the currency. Only mandatory when a payment is the originator.
originator.data.money.currency	String	-	(O)	3	The currency of the transaction. Format: 3-character abbreviation according to ISO 4217. Only mandatory when a payment is the originator.
originator.data.transactions.transactionId	String	-	(O)	36	The unique identifier of the payment transaction. Format UUID. Only mandatory when a payment is the originator.
originator.data.transactions.transactionCreationDate	Instant	-	(O)	20	The date and time when a transaction is created in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ. Only mandatory when a payment is the originator.
originator.data.transactions.transactionStatus	String	-	(O)	10	The status of a transaction. This field admits the following values: success failed
originator.data.transactions.isFallback	Boolean	-	(O)	true/false	Indicates whether the current transaction has used the main MID of the route or has used the fallback MID. Only mandatory when a payment is the originator.
data.subscriptionId	String	-	(M)	36	The unique identifier of the subscription. Format UUID.
data.planId	String	-	(M)	36	The unique identifier of the plan. Format UUID.
data.status	String (Enum)	-	(M)	20	The subscription status. This field admits the following values: created abandoned archived fulfilled past_due maintenance cancelled paused
data.cycle	Integer	-	(M)	3	The number of paid cycles
data.nextPayment.scheduledFor	Instant	-	(O)	20	Date and time of the next payment. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.
data.nextPayment.type	String (Enum)	-	(O)	20	Type of the next payment. This field admits the following values: renewal maintenance
data.nextPayment.money.amount	BigDecimal	-	(O)	38	The amount of the cycle. The amount of the decimal place depends on the currency. Only mandatory when a payment is the originator.
data.nextPayment.money.currency	String	-	(O)	3	The currency of the cycle. Format: 3-character abbreviation according to ISO 4217. Only mandatory when a payment is the originator.
data.customer.email	String	-	(O)	254	The email address of the customer.
data.createdAt	Instant	-	(M)	20	The date and time when a subscription is created in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.
data.modifiedAt	Instant	-	(M)	20	The date and time when a subscription is modified in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.
data.cancellation.reason	String (Enum)	-	(O)	20	Cancellation reason of the subscription. This field admits the following values: end_plan: The subscription is canceled because it reaches the end of the plan. hard_decline: The subscription is canceled because we received a hard decline from the PSP. merchant_api: The subscription is canceled by a merchant API request. backoffice_api: The subscription is canceled from our BO. dispute: The subscription is canceled by Chargeback or RDR and the plan is set to auto cancel. cancellation_settings: The subscription was set to cancel automatically after a specified time or cycle (adjusting to the enduser's needs).
data.cancellation.detail	String	(O)	(O)	25	Short description about the cancellation reason
data.cancellation.requestedAt	Instant	-	(O)	20	The date and time when a subscription is cancelled in UTC. Format: ISO 8601 in UTC / YYYY-MM-DDTHH:mm:ssZ.