This method is extending the grace period of a draft, effective, not effective subscription. The method can be applied on a single subscription only
Resource URL
Parameters
Name | Type | Description | ||||||||||||||||||||||||||||||
token | String | The token retrieved from the login method | ||||||||||||||||||||||||||||||
subscription_identifier (semi-optional) | Subscription identifier | The subscription on which the Grace Period will be applied. The action can only be performed on Draft, Effective or Not Effective subscriptions. The allowed subscription identifier fields are the following:
For releases prior to CRM.COM R13.0.0 the subscription_identifier is mandatory From CRM.COM R14.0.0, grace periods can also be applied on Draft subscriptions | ||||||||||||||||||||||||||||||
accounts_receivable_identifier (semi-optional) | Accounts Receivable Identifier | The accounts receivable identifier that can be used to perform the subscription modification. The allowed accounts receivable identifier fields are the following:
The ability to use the accounts_receivable_identifier instead of the subscription_identifier is applicable only when the specified Accounts Receivable owns only one Subscription Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
action_type_identifier (optional) | Subscription action type identifier | The action type that should be used. The allowed subscription action type identifier fields are the following:
| ||||||||||||||||||||||||||||||
sub_action_type_identifier (optional) | Subscription sub action type identifier | The sub action type that should be used. The allowed subscription sub action type identifier fields are the following:
| ||||||||||||||||||||||||||||||
transaction_reference_number (optional) | String | The transaction reference number of the performed subscription action. The transaction reference number is unique against already submitted subscription actions. Available from CRM.COM R13.0.0 | ||||||||||||||||||||||||||||||
end_grace_period_on (semi-optional) | Date | The date that the grace period should end. End grace period on date is mandatory unless end grace period after specific days is specified. It is not allowed to specify both information | ||||||||||||||||||||||||||||||
end_grace_period_after_specific_days (semi-optional) | Number | It defines the date that the grace period period should end, based on the date that the extended grace period was applied and the specified number of days. End grace period after specific days is mandatory unless end grace period on date is specified. It is not allowed to specify both information | ||||||||||||||||||||||||||||||
performed_by_user_identifier (optional) | User identifier | The user that actually performed the action. The allowed user identifier fields are the following:
| ||||||||||||||||||||||||||||||
performed_by_unit_identifier (optional) | Unit Identifier | The unit that performed the action. The allowed unit identifier fields are the following:
Available from CRM.COM R14.0.0 | ||||||||||||||||||||||||||||||
performed_on (optional) | Date | The date that the action was actually performed | ||||||||||||||||||||||||||||||
billing_effective_date (optional) | Date | Determines when the subscription services that are affected by the subscription action should be billed by the billing engine. | ||||||||||||||||||||||||||||||
billable_period_start_date (optional) | Date | Determines the start date of the billable period of each subscription service (it answers to the question “from which date should I start billing this service) that is affected by the subscription action. | ||||||||||||||||||||||||||||||
scheduled_date (optional) | Date | The date that the action is scheduled to be executed. If not specified then the action will be executed immediately
| ||||||||||||||||||||||||||||||
udf_string_1 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_2 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_3 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_4 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_5 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_6 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_7 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_string_8 (optional) | String | User Defined Field of type String | ||||||||||||||||||||||||||||||
udf_float_1 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_2 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_3 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_float_4 (optional) | Float | User Defined Field of type Float | ||||||||||||||||||||||||||||||
udf_date_1 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_2 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_3 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
udf_date_4 (optional) | Date | User Defined Field of type Date | ||||||||||||||||||||||||||||||
fields_set (optional)
| List of Strings, comma separated | A list of fields that should be included in the results. If not specified then all the available fields will be returned |
Restrictions
- It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.
Response Data
Examples
HTTP Method: POST
Request:
Body:
{
"token":"E2C3E95B3D5E4A32BA1C33BD366A5058",
"subscription_identifier":{"number":"S60315"},
"action_type_identifier" : {"name" : "Extend Grace Period"},
"sub_action_type_identifier" : {"name":"Grace Period"},
"end_grace_period_after_specific_days":2
}
Response:
{
"status":
{
"message": null,
"description": null,
"code": "OK"
},
"data":
{
"scheduled_date": "2015-03-19T13:18:22",
"action_type":
{
"name": "Extend Grace Period",
"id": "189DB126CC60FA55C82698E25063BA30",
"alternative_code": "E_G_P"
},
"submitted_on": "2015-03-19T13:18:22",
"sub_action_type":
{
"name": "Grace Period",
"id": "49FD0AEBF7C1D01AA2957BFDD3A0D1E7",
"alternative_code": "Grace Period"
},
"business_classification_code": "EXTEND_GRACE_PERIOD",
"number": "754",
"executed_on": "2015-03-19T13:18:23",
"life_cycle_state": "EXECUTED",
"performed_by":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
},
"behavior_code": "EXTEND_GRACE_PERIOD",
"submitted_by":
{
"person_name": "Marios Lannister",
"username": "mpadministrator",
"id": "1"
},
"id": "FA6C3638C6914BC686B8FF583F298CBC",
"subscription":
{
"accounts_receivable":
{
"account_owner":
{
"last_name": "Papapavlou",
"life_cycle_state": "FINANCIAL",
"middle_name": "Andreas",
"company_profile": null,
"title": "Ms",
"type": "PERSON",
"first_name": "Lucia",
"name": "Lucia Papapavlou",
"id": "1D92B269658D80DEDF2499E25201739E",
"company_name": null,
"demographics":
{
"gender": "FEMALE",
"passport_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"passport_number": "113115",
"social_security_number": "113116",
"country_of_residence":
{
"name": "UNITED KINGDOM",
"id": "126"
},
"industry_sector":
{
"name": "GOVERNMENTAL",
"id": "A9BDEBD4D8FAEDB0BACE40C041156D12",
"alternative_code": "GOV"
},
"date_of_birth":
{
"month": 1,
"day": 1,
"year": 1990
},
"name_day":
{
"month": 5,
"day": 5
},
"id_number": "113114",
"id_issued_by_country":
{
"name": "GREECE",
"id": "209"
},
"industry":
{
"name": "Interior Design",
"id": "06B638258885DA26FA2BD40D9128D04E",
"code": "INTDS"
}
}
},
"life_cycle_state": "ACTIVE",
"number": "437",
"name": "Change API Acount",
"id": "AD428A613F5CF0571EA8D1345CE9E450"
},
"life_cycle_state": "EFFECTIVE",
"number": "S60315",
"type":
{
"name": "London",
"id": "3100B0D56E7C7EADF073C34BCE1E42AF",
"description": "For Subscribers residing in London
",
"alternative_code": "LND"
},
"id": "59D30407589847498957D7E570FAC0BB"
},
"performed_on": "2015-03-19T13:18:21"
}
}