The Redaction Job object Preview

Attributes

• idstring

  Unique identifier for the object.

• objectstring

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

• createdtimestamp

  Time at which the object was created. 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.

• objectsnullable objectExpandable

  The objects to redact in this job.

  Hide child attributes

  • objects.chargesnullable array of strings

    Charge object identifiers usually starting with ch_

  • objects.checkout_sessionsnullable array of strings

    CheckoutSession object identifiers starting with cs_

  • objects.customersnullable array of strings

    Customer object identifiers starting with cus_

  • objects.identity_verification_sessionsnullable array of strings

    Identity VerificationSessions object identifiers starting with vs_

  • objects.invoicesnullable array of strings

    Invoice object identifiers starting with in_

  • objects.issuing_cardholdersnullable array of strings

    Issuing Cardholder object identifiers starting with ich_

  • objects.payment_intentsnullable array of strings

    PaymentIntent object identifiers starting with pi_

  • objects.radar_value_list_itemsnullable array of strings

    Fraud ValueListItem object identifiers starting with rsli_

  • objects.setup_intentsnullable array of strings

    SetupIntent object identifiers starting with seti_

• statusenum

  The status of the job.

  Possible enum values

  canceled The job is canceled. No objects are redacted.

  canceling The job is canceling and no objects will be redacted.

  created This job is newly created and will begin validating shortly.

  failed The job failed to validate. View the job’s validation errors for more information.

  ready The job is ready to run or cancel.

  redacting The job is running. It is redacting the job’s specified objects.

  succeeded The job is complete. The job’s objects are redacted.

  validating The job is checking if the objects are eligible for redaction.

• validation_behaviornullable enum

  Validation behavior determines how a job validates objects for redaction eligibility. Default is error.

  Possible enum values

  error The job will generate a validation error for every object that cannot be redacted. If there are any errors, all of them will need to be resolved before the job can run.

  fix The job will attempt to fix validation errors whenever possible. Some objects cannot be automatically fixed and will need to be resolved before the job can run.