Attributes

• idstring

  Unique identifier for the object.

• objectstring

  String representing the object’s type. Objects of the same type share the same value.

• active_fromtimestamp

  Time at which the registration becomes active. Measured in seconds since the Unix epoch.

• countrystring

  Two-letter country code (ISO 3166-1 alpha-2).

• country_optionsobject

  Specific options for a registration in the specified country.

  Show child attributes

• createdtimestamp

  Time at which the object was created. Measured in seconds since the Unix epoch.

• expires_atnullable timestamp

  If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. Measured in seconds since the Unix epoch.

• livemodeboolean

  Has the value true if the object exists in live mode or the value false if the object exists in test mode.

• statusenum

  The status of the registration. This field is present for convenience and can be deduced from active_from and expires_at.

  Possible enum values

  active The Tax Registration is currently active.

  expired The Tax Registration is no longer active.

  scheduled The Tax Registration will become active in the future.

Creates a new Tax Registration object.

Parameters

• active_fromstring | timestampRequired

  Time at which the Tax Registration becomes active. It can be either now to indicate the current time, or a future timestamp measured in seconds since the Unix epoch.

• countrystringRequired

  Two-letter country code (ISO 3166-1 alpha-2).

• country_optionsobjectRequired

  Specific options for a registration in the specified country.

  Show child parameters

• expires_attimestamp

  If set, the Tax Registration stops being active at this time. If not set, the Tax Registration will be active indefinitely. Timestamp measured in seconds since the Unix epoch.

Updates an existing Tax Registration object.

A registration cannot be deleted after it has been created. If you wish to end a registration you may do so by setting expires_at.

Parameters

• active_fromstring | timestamp

  Time at which the registration becomes active. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

• expires_atstring | timestamp

  If set, the registration stops being active at this time. If not set, the registration will be active indefinitely. It can be either now to indicate the current time, or a timestamp measured in seconds since the Unix epoch.

Returns a Tax Registration object.

Parameters

No parameters.