Summary

API Name	cancel_unapplied_service_credits_m
Class	account_services_m
Update Version	6.35

Description

Cancels all unapplied service credits and any partially consumed recurring credits on an account or a specific master plan instance (subscription). Service credits reduce charges at invoicing time; "unapplied" credits are those that have been created but not yet consumed by an invoice. This API removes those pending credits so they will not reduce future invoices. Partially used recurring credits (where some portion of the credit amount remains) are also cancelled.

Use this API when you need to revoke service credits — for example, if credits were applied in error, a promotional period ended, or account circumstances changed. To view unapplied credits before cancelling them, use get_unapplied_service_credits_m. To cancel credits generated by a specific coupon, use cancel_unconsumed_credit_m.

Inputs

Name	Type	Length	Required	Description
client_no	long	22	Yes	Aria-assigned unique identifier indicating the Aria client providing service to this account.
auth_key	string	32	Yes	Aria-assigned unique key for authenticating the validity of the requestor. This key is passed with each method call.
acct_no	long	22	Yes	Aria-assigned account identifier. This value is unique across all Aria-managed accounts. Alternative required field: client_acct_id
client_acct_id	string	50	Yes	Client-defined account identifier. Alternative required field: acct_no
master_plan_instance_no	long	22	No	The Master Subscription plan instance number. Alternative field: client_master_plan_instance_id
client_master_plan_instance_id	string	100	No	Client-defined Master plan Subscription plan instance ID. Alternative field: master_plan_instance_no
credit_ids	object		Yes	See fields below

credit_ids fields

Name	Type	Length	Required	Description
credit_ids	string		Yes	Array of credit ids.

Outputs

Name	Type	Length	Required	Description
error_code	long		No	Aria-assigned error identifier. 0 indicates no error.
error_msg	string		No	Description of any error that occurred. "OK" if there was no error.