Recurring charge plan disabled

Event generated when a recurring charge plan is disabled.

Type: object
Domain: balance
Event: recurring_charge_plan_disabled
Version: 1

|
recurring_charge_plan_id required

Description: Recurring charge plan ID
Type: number
Example:
9832195123

org_id required

Description: Organization ID
Type: string
Example:
TN-cc8f8b89-233a-4582-9f36-63ee85278d6d

created_at required

Description: Plan creation date and time in ISO-8601 format
Type: string
Format: date-time
Example:
2021-10-18T15:23:17Z

description required

Description: Plans description **Type**: string **Example**: Description of the recurring charge plan.`

installment_amount required

Description: Credit transaction total amount
Type: number
Example:
12.0

number_of_cycles required

Description: The number of cycles that composes the recurring charge plan.
Type: integer
Example:
12

automatic_renew

Description: Flag that enables plans automatic renew. **Type**: boolean **Example**: true`

processing_code required

Description: Charactere sequence that represents a group of resultant transactions.
Type: string
Example:
009999

tracking_id required

Title: Trancking ID
Description: This is a unique field.
Type: string
Format: uuid
Example:
12766d76-6e0d-99fa-8209-d236f4fbb4a2

disabled_at required

Description: Plan disablement date and time in ISO-8601 format
Type: string
Format: date-time
Example:
2021-10-18T15:23:17Z

first_cycles_to_skip

Description: The number of initial cycles to skip.
Type: integer
Example:
3

discount_percentage

Description: The discount percentage apply to the following charge.
Type: number
Example:
12

secondary_description

Description: Plans secondary description **Type**: string **Example**: Secondary description of the recurring charge plan.`

secondary_processing_code

Description: Charactere sequence that represents a group of resultant transactions.
Type: string
Example:
009999

minimum_sepend_to_charge

Description: The minimum value spent to charge the client.
Type: number
Example:
120.0

renew_method

Description: Plans renew method **Type**: string **Example**: NO_RENEW WITHOUT_DISCOUNT WITH_DISCOUNT`

cid required

Title: Correlational ID of event
Description: This is not a unique value, so different events (from same domain+event_type or not) can share same cid. This is usefull to identify all events produced from same request or processing.
Type: string
Format: uuid
Example:
12766d76-6e0d-99fa-8209-d236f4fbb4a2

{
    "$schema": "http://json-schema.org/draft-04/schema#",
    "type": "object",
    "title": "Recurring charge plan disabled",
    "description": "Event generated when a recurring charge plan is disabled.",
    "required": [
        "recurring_charge_plan_id",
        "org_id",
        "created_at",
        "processing_code",
        "installment_amount",
        "description",
        "number_of_cycles",
        "tracking_id",
        "disabled_at",
        "cid"
    ],
    "properties": {
        "recurring_charge_plan_id": {
            "type": "number",
            "description": "Recurring charge plan ID",
            "examples": [
                9832195123
            ]
        },
        "org_id": {
            "type": "string",
            "description": "Organization ID",
            "examples": [
                "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d"
            ]
        },
        "created_at": {
            "type": "string",
            "description": "Plan creation date and time in ISO-8601 format",
            "format": "date-time",
            "examples": [
                "2021-10-18T15:23:17Z"
            ]
        },
        "description": {
            "type": "string",
            "description": "Plan`s description",
            "examples": [
                "Description of the recurring charge plan."
            ]
        },
        "installment_amount": {
            "type": "number",
            "description": "Credit transaction total amount",
            "examples": [
                12.0
            ]
        },
        "number_of_cycles": {
            "type": "integer",
            "description": "The number of cycles that composes the recurring charge plan.",
            "examples": [
                12
            ]
        },
        "automatic_renew": {
            "type": "boolean",
            "description": "Flag that enables plan`s automatic renew.",
            "examples": [
                true
            ]
        },
        "processing_code": {
            "type": "string",
            "description": "Charactere sequence that represents a group of resultant transactions.",
            "examples": [
                "009999"
            ]
        },
        "tracking_id": {
            "type": "string",
            "format": "uuid",
            "title": "Trancking ID",
            "description": "This is a unique field.",
            "pattern": "^(?!\\s*$).+",
            "examples": [
                "12766d76-6e0d-99fa-8209-d236f4fbb4a2"
            ]
        },
        "disabled_at": {
            "type": "string",
            "description": "Plan disablement date and time in ISO-8601 format",
            "format": "date-time",
            "examples": [
                "2021-10-18T15:23:17Z"
            ]
        },
        "first_cycles_to_skip": {
            "type": "integer",
            "description": "The number of initial cycles to skip.",
            "examples": [
                3
            ]
        },
        "discount_percentage": {
            "type": "number",
            "description": "The discount percentage apply to the following charge.",
            "examples": [
                12
            ]
        },
        "secondary_description": {
            "type": "string",
            "description": "Plan`s secondary description",
            "examples": [
                "Secondary description of the recurring charge plan."
            ]
        },
        "secondary_processing_code": {
            "type": "string",
            "description": "Charactere sequence that represents a group of resultant transactions.",
            "examples": [
                "009999"
            ]
        },
        "minimum_sepend_to_charge": {
            "type": "number",
            "description": "The minimum value spent to charge the client.",
            "examples": [
                120.0
            ]
        },
        "renew_method": {
            "type": "string",
            "description": "Plan`s renew method",
            "examples": [
                "NO_RENEW",
                "WITHOUT_DISCOUNT",
                "WITH_DISCOUNT"
            ]
        },
        "cid": {
            "type": "string",
            "format": "uuid",
            "title": "Correlational ID of event",
            "description": "This is not a unique value, so different events (from same domain+event_type or not) can share same cid. This is usefull to identify all events produced from same request or processing.",
            "pattern": "^(?!\\s*$).+",
            "examples": [
                "12766d76-6e0d-99fa-8209-d236f4fbb4a2"
            ]
        }
    }
}
{
    "recurring_charge_plan_id": 9832195123,
    "org_id": "TN-cc8f8b89-233a-4582-9f36-63ee85278d6d",
    "created_at": "2021-10-18T15:23:17Z",
    "description": "Description of the recurring charge plan.",
    "installment_amount": 12.0,
    "number_of_cycles": 12,
    "automatic_renew": true,
    "processing_code": "009999",
    "tracking_id": "12766d76-6e0d-99fa-8209-d236f4fbb4a2",
    "disabled_at": "2021-10-18T15:23:17Z",
    "first_cycles_to_skip": 3,
    "discount_percentage": 12,
    "secondary_description": "Secondary description of the recurring charge plan.",
    "secondary_processing_code": "009999",
    "minimum_sepend_to_charge": 120.0,
    "renew_method": "NO_RENEW",
    "cid": "12766d76-6e0d-99fa-8209-d236f4fbb4a2"
}