Account.md

Bfwd::Account

Properties

Name	Type	Description	Notes
crm_id	String	{ "description" : "CRM ID of the account.", "verbs":["GET"] }	[optional]
created	DateTime	{ "description" : "The UTC DateTime when the object was created.", "verbs":[] }	[optional]
changed_by	String	{ "description" : "ID of the user who last updated the entity.", "verbs":[] }	[optional]
updated	DateTime	{ "description" : "The UTC DateTime when the object was last updated.", "verbs":[] }	[optional]
metadata	DynamicMetadata	{ "description" : "Add metadata.", "verbs":["POST"] }	[optional]
id	String	{ "description" : "ID of the account.", "verbs":["GET"] }
organization_id	String	{ "description" : "Organization associated with the account.", "verbs":[] }
user_id	String	{ "description" : "User associated with the account. If this is null, no user is currently assocaited with the account. A user is only set when an account is associated with a user account.", "verbs":[] }	[optional]
successful_subscriptions	Integer	{ "description" : "Number of distinct, paid subscriptions associated with this account. Initially the value will be 0 when no successful subscriptions have been taken. A subscription cancelled whilst in trial is counted as successful.", "verbs":["GET"] }	[optional]
aggregating_product_rate_plan_id	String	{ "description" : "If present, this will be the product rate plan to use when creating an aggregating subscription. An account level aggregating subscription will be created when the first subscription is created against the account.", "verbs":[] }	[optional]
aggregating_subscription_id	String	{ "description" : "The consistent ID of the account level aggregating subscription, if one exists.", "verbs":[] }	[optional]
deleted	BOOLEAN	{ "default" : "false", "description" : "Indicates if an account has been retired. If an account has been retired it can still be retrieved using the appropriate flag on API requests.", "verbs":["GET"] }	[optional] [default to false]
profile	Profile		[optional]
payment_methods	Array<PaymentMethod>	{ &quot;description&quot; : &quot;The payment-methods associated with the account.&quot;, &quot;verbs&quot;:[&quot;GET&quot;] }	[optional]