PlanDocument

  • Name
    object
    Type
    string
    Description

    Type of object is always planDocument.

    Allowed values: planDocument 
  • Name
    id
    Type
    string
    Description

    Unique identifier for the given document.

    Example: "pdc_0SNlurA049MEWV1S6e1qVqBV2xge"
  • Name
    createdAt
    Type
    string
    Description

    The time the document was created.

    Example: "2022-07-04T16:20:27.59Z"
  • Name
    language
    Type
    nullable string
    Status
    PREVIEW
    Description

    The language of the document. The values follow the BCP 47 standard. That means, for instance, that a region can be specified in addition to the language.

    Example: "en-US"
  • Name
    name
    Type
    string
    Description

    The name of the document.

    Example: "My Plan Contract"
  • Name
    plan
    Type
    string
    Description

    Unique identifier for the plan associated to this document.

    Example: "pln_0SNlurA049MEWV3V0q7gjQbM4EVo"
  • Name
    type
    Type
    string
    Description

    The MIME type for the given document.

    Example: "application/pdf"
  • Name
    url
    Type
    string
    Description

    The URL at which the document can be retrieved.

    Example: "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"

Example

{
  "object": "planDocument",
  "id": "pdc_0SNlurA049MEWV1S6e1qVqBV2xge",
  "createdAt": "2022-07-04T16:20:27.0Z",
  "language": "en-US",
  "name": "My Plan Contract",
  "plan": "pln_0SNlurA049MEWV3V0q7gjQbM4EVo",
  "type": "application/pdf",
  "url": "https://a.gigscdn.net/p/my-project/01G74ZPB5PQTDESM4JGYR2CWB9.pdf"
}