Skip to main content

CustomerWriteBase

Struct CustomerWriteBase 

Source
pub struct CustomerWriteBase {
    pub capabilities: Option<CapabilitiesMapInput>,
    pub compliance: Option<Compliance>,
    pub individual: Option<IndividualInput>,
    pub project_ids: Vec<ProjectId>,
    pub tax_attestations: Vec<TaxAttestation>,
    pub tos_acceptances: Vec<TosAcceptance>,
    pub type_: Option<CustomerType>,
}
Expand description

Fields accepted on customer create and update requests. Shared by CreateCustomerRequest and UpdateCustomerRequest; excludes the server-managed response-only fields that appear on Customer.

JSON schema
{
 "description": "Fields accepted on customer create and update requests. Shared by\n`CreateCustomerRequest` and `UpdateCustomerRequest`; excludes the\nserver-managed response-only fields that appear on `Customer`.\n",
 "type": "object",
 "properties": {
   "capabilities": {
     "description": "Capabilities to request for the customer.",
     "examples": [
       {}
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/CapabilitiesMapInput"
       }
     ]
   },
   "compliance": {
     "$ref": "#/components/schemas/Compliance"
   },
   "individual": {
     "description": "Information about an Individual customer. Not all fields are required\nfor all customers; the requirements depend on which capabilities are\nrequested. Submit only fields that are required by the capabilities\nthat have been requested.\n",
     "examples": [
       {
         "firstName": "Jane",
         "lastName": "Doe"
       }
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/IndividualInput"
       }
     ]
   },
   "projectIds": {
     "description": "The project IDs that this customer is associated with.",
     "examples": [
       []
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/ProjectId"
     }
   },
   "taxAttestations": {
     "description": "Tax attestations to record on the customer. Submit one entry per\nrequired form surfaced inline on\n`requirements.taxAttestation.taxForms[]` (returned by `Get Customer`,\n`Create Customer`, and `Update Customer` whenever a `taxAttestation`\nrequirement is unsatisfied). The required fields per entry depend on\n`form`; see `TaxAttestation`. This field is ingestion-only and is\nnever returned on read.\n\nOmit `taxAttestations` on a partial update to leave previously\nrecorded attestations unchanged. Sending `taxAttestations: []` is\ninvalid (`errorType: \"invalid_request\"`) because it would clear all\nattestations without replacing them; omit the field entirely when you\nare not updating tax attestations.\n",
     "writeOnly": true,
     "examples": [
       [
         {
           "acceptedAt": "2026-04-17T20:00:00Z",
           "edeliveryConsent": true,
           "form": "us_w9",
           "isExemptBackupWithholding": true
         }
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/TaxAttestation"
     }
   },
   "tosAcceptances": {
     "description": "Terms of Service acceptances to record on the customer. Submit one\nentry per required version surfaced inline on\n`requirements.tos.tosVersions[]` (returned by `Get Customer`,\n`Create Customer`, and `Update Customer` whenever a `tos` requirement\nis unsatisfied). The server rejects each acceptance whose `language`\nis not listed under `languages` on the matching required version with\n`errorType: \"unsupported_tos_language\"`.\n\nWhen new required Terms of Service versions are published, only the\nnew `versionId`s appear in `requirements.tos.tosVersions[]`; submit\nacceptances for only those new version(s).\n\nOmit `tosAcceptances` on a partial update to leave previously recorded\nacceptances unchanged. Sending `tosAcceptances: []` is invalid\n(`errorType: \"invalid_request\"`) because it would clear all acceptances\nwithout replacing them; omit the field entirely when you are not\nupdating Terms of Service acceptances.\n",
     "examples": [
       [
         {
           "acceptedAt": "2026-04-10T12:00:00Z",
           "language": "en",
           "versionId": "us_individual_2026-05-29"
         }
       ]
     ],
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/TosAcceptance"
     }
   },
   "type": {
     "description": "The type of the customer. Required on create; accepted but ignored on\nupdate.\n",
     "examples": [
       "individual"
     ],
     "allOf": [
       {
         "$ref": "#/components/schemas/CustomerType"
       }
     ]
   }
 },
 "additionalProperties": false
}

Fields§

§capabilities: Option<CapabilitiesMapInput>

Capabilities to request for the customer.

§compliance: Option<Compliance>§individual: Option<IndividualInput>

Information about an Individual customer. Not all fields are required for all customers; the requirements depend on which capabilities are requested. Submit only fields that are required by the capabilities that have been requested.

§project_ids: Vec<ProjectId>

The project IDs that this customer is associated with.

§tax_attestations: Vec<TaxAttestation>

Tax attestations to record on the customer. Submit one entry per required form surfaced inline on requirements.taxAttestation.taxForms[] (returned by Get Customer, Create Customer, and Update Customer whenever a taxAttestation requirement is unsatisfied). The required fields per entry depend on form; see TaxAttestation. This field is ingestion-only and is never returned on read.

    Omit `taxAttestations` on a partial update to leave previously
    recorded attestations unchanged. Sending `taxAttestations: []` is
    invalid (`errorType: "invalid_request"`) because it would clear all
    attestations without replacing them; omit the field entirely when you
    are not updating tax attestations.
§tos_acceptances: Vec<TosAcceptance>

Terms of Service acceptances to record on the customer. Submit one entry per required version surfaced inline on requirements.tos.tosVersions[] (returned by Get Customer, Create Customer, and Update Customer whenever a tos requirement is unsatisfied). The server rejects each acceptance whose language is not listed under languages on the matching required version with errorType: "unsupported_tos_language".

    When new required Terms of Service versions are published, only the
    new `versionId`s appear in `requirements.tos.tosVersions[]`; submit
    acceptances for only those new version(s).

    Omit `tosAcceptances` on a partial update to leave previously recorded
    acceptances unchanged. Sending `tosAcceptances: []` is invalid
    (`errorType: "invalid_request"`) because it would clear all acceptances
    without replacing them; omit the field entirely when you are not
    updating Terms of Service acceptances.
§type_: Option<CustomerType>

The type of the customer. Required on create; accepted but ignored on update.

Implementations§

Trait Implementations§

Source§

impl Clone for CustomerWriteBase

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for CustomerWriteBase

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for CustomerWriteBase

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for CustomerWriteBase

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&CustomerWriteBase> for CustomerWriteBase

Source§

fn from(value: &CustomerWriteBase) -> Self

Converts to this type from the input type.
Source§

impl From<CreateCustomerRequest> for CustomerWriteBase

Source§

fn from(value: CreateCustomerRequest) -> Self

Converts to this type from the input type.
Source§

impl From<CustomerWriteBase> for CreateCustomerRequest

Source§

fn from(value: CustomerWriteBase) -> Self

Converts to this type from the input type.
Source§

impl From<CustomerWriteBase> for UpdateCustomerRequest

Source§

fn from(value: CustomerWriteBase) -> Self

Converts to this type from the input type.
Source§

impl From<CustomerWriteBase> for CustomerWriteBase

Source§

fn from(value: CustomerWriteBase) -> Self

Converts to this type from the input type.
Source§

impl From<UpdateCustomerRequest> for CustomerWriteBase

Source§

fn from(value: UpdateCustomerRequest) -> Self

Converts to this type from the input type.
Source§

impl Serialize for CustomerWriteBase

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl TryFrom<CustomerWriteBase> for CustomerWriteBase

Source§

type Error = ConversionError

The type returned in the event of a conversion error.
Source§

fn try_from(value: CustomerWriteBase) -> Result<Self, ConversionError>

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more