.. _module-utility-credential-app-v0-model-offer-76929:

Utility.Credential.App.V0.Model.Offer
=====================================

Templates
---------

.. _type-utility-credential-app-v0-model-offer-credentialoffer-79563:

**template** `CredentialOffer <type-utility-credential-app-v0-model-offer-credentialoffer-79563_>`_

  An offer to create a credential, including the subscription price\.

  Signatory\: operator, issuer

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - operator
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Utility operator\.
     * - issuer
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Issuer of the credential\.
     * - holder
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - Holder of the credential\.
     * - dso
       - `Party <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-party-57932>`_
       - DSO (Decentralized Synchronizer Operations) party\.
     * - id
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Identifier of the credential\.
     * - description
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Description of the credential\.
     * - claims
       - \[`Claim <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-claim-45224>`_\]
       - Claims contained in the credential\.
     * - billingParams
       - `Optional <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-prelude-optional-37153>`_ :ref:`BillingParams <type-utility-credential-app-v0-types-billingparams-7107>`
       - Billing parameters for the credential\.
     * - depositInitialAmountUsd
       - `Optional <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-prelude-optional-37153>`_ `Decimal <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-decimal-18135>`_
       - The amount of $ to be initially locked (as CC) as a deposit to cover fee payments\. It can be different than the ``targetAmount`` specified in the credential billing parameters\.

  + **Choice** Archive

    Controller\: operator, issuer

    Returns\: ()

    (no fields)

  + .. _type-utility-credential-app-v0-model-offer-credentialofferacceptfree-23717:

    **Choice** `CredentialOffer_AcceptFree <type-utility-credential-app-v0-model-offer-credentialofferacceptfree-23717_>`_

    Accepts a free credential offer\.

    Controller\: holder

    Returns\: `CredentialOffer_AcceptFree_Result <type-utility-credential-app-v0-model-offer-credentialofferacceptfreeresult-6026_>`_

    (no fields)

  + .. _type-utility-credential-app-v0-model-offer-credentialofferacceptpaid-83993:

    **Choice** `CredentialOffer_AcceptPaid <type-utility-credential-app-v0-model-offer-credentialofferacceptpaid-83993_>`_

    Accepts a paid credential offer\.

    Controller\: holder, operator

    Returns\: `CredentialOffer_AcceptPaid_Result <type-utility-credential-app-v0-model-offer-credentialofferacceptpaidresult-26910_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - holderInputs
         - \[`ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Amulet <https://global.canton.network.digitalasset.com/app_dev/api/splice-amulet/Splice-Amulet.html#type-splice-amulet-amulet-63582>`_\]
         - Amulet to be used to fund the deposit\.
       * - appTransferContext
         - `AppTransferContext <https://global.canton.network.digitalasset.com/app_dev/api/splice-amulet/Splice-AmuletRules.html#type-splice-amuletrules-apptransfercontext-68083>`_
         - Context for the deposit funding transfer (effectively it is a lock rather than a Transfer)\.

  + .. _type-utility-credential-app-v0-model-offer-credentialoffercancel-9969:

    **Choice** `CredentialOffer_Cancel <type-utility-credential-app-v0-model-offer-credentialoffercancel-9969_>`_

    Cancels the credential offer\.

    Controller\: issuer, operator

    Returns\: `CredentialOffer_Cancel_Result <type-utility-credential-app-v0-model-offer-credentialoffercancelresult-22198_>`_

    (no fields)

  + .. _type-utility-credential-app-v0-model-offer-credentialofferreject-42178:

    **Choice** `CredentialOffer_Reject <type-utility-credential-app-v0-model-offer-credentialofferreject-42178_>`_

    Rejects the credential offer\.

    Controller\: holder, operator

    Returns\: `CredentialOffer_Reject_Result <type-utility-credential-app-v0-model-offer-credentialofferrejectresult-51763_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - reason
         - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
         - Reject reason\.

.. _type-utility-credential-app-v0-model-offer-rejectedcredentialoffer-74949:

**template** `RejectedCredentialOffer <type-utility-credential-app-v0-model-offer-rejectedcredentialoffer-74949_>`_

  A rejected credential offer\.

  Signatory\: (DA\.Internal\.Record\.getField @\"operator\" offer)

  .. list-table::
     :widths: 15 10 30
     :header-rows: 1

     * - Field
       - Type
       - Description
     * - offer
       - `CredentialOffer <type-utility-credential-app-v0-model-offer-credentialoffer-79563_>`_
       - Rejected offer payload\.
     * - reason
       - `Text <https://docs.daml.com/daml/stdlib/Prelude.html#type-ghc-types-text-51952>`_
       - Reject reason\.

  + **Choice** Archive

    Controller\: (DA\.Internal\.Record\.getField @\"operator\" offer)

    Returns\: ()

    (no fields)

Data Types
----------

.. _type-utility-credential-app-v0-model-offer-credentialofferacceptfreeresult-6026:

**data** `CredentialOffer_AcceptFree_Result <type-utility-credential-app-v0-model-offer-credentialofferacceptfreeresult-6026_>`_

  Result of accepting the offer for a free credential\.

  .. _constr-utility-credential-app-v0-model-offer-credentialofferacceptfreeresult-96593:

  `CredentialOffer_AcceptFree_Result <constr-utility-credential-app-v0-model-offer-credentialofferacceptfreeresult-96593_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - credentialCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Credential <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-credential-66032>`_
         - The credential\.

.. _type-utility-credential-app-v0-model-offer-credentialofferacceptpaidresult-26910:

**data** `CredentialOffer_AcceptPaid_Result <type-utility-credential-app-v0-model-offer-credentialofferacceptpaidresult-26910_>`_

  Result of accepting the offer for a paid credential\.

  .. _constr-utility-credential-app-v0-model-offer-credentialofferacceptpaidresult-91857:

  `CredentialOffer_AcceptPaid_Result <constr-utility-credential-app-v0-model-offer-credentialofferacceptpaidresult-91857_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - credentialBillingCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ :ref:`CredentialBilling <type-utility-credential-app-v0-model-billing-credentialbilling-78403>`
         - The credential billing\.
       * - credentialCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `Credential <https://docs.utility.canton.network.digitalasset.com/doc/daml-api/html/credential-model/Utility-Credential-V0-Credential.html#type-utility-credential-v0-credential-credential-66032>`_
         - The credential\.

.. _type-utility-credential-app-v0-model-offer-credentialoffercancelresult-22198:

**data** `CredentialOffer_Cancel_Result <type-utility-credential-app-v0-model-offer-credentialoffercancelresult-22198_>`_

  Result of canceling the offer for a paid credential\.

  .. _constr-utility-credential-app-v0-model-offer-credentialoffercancelresult-4537:

  `CredentialOffer_Cancel_Result <constr-utility-credential-app-v0-model-offer-credentialoffercancelresult-4537_>`_

    (no fields)

.. _type-utility-credential-app-v0-model-offer-credentialofferrejectresult-51763:

**data** `CredentialOffer_Reject_Result <type-utility-credential-app-v0-model-offer-credentialofferrejectresult-51763_>`_

  Result of rejecting the offer for a paid credential\.

  .. _constr-utility-credential-app-v0-model-offer-credentialofferrejectresult-95176:

  `CredentialOffer_Reject_Result <constr-utility-credential-app-v0-model-offer-credentialofferrejectresult-95176_>`_

    .. list-table::
       :widths: 15 10 30
       :header-rows: 1

       * - Field
         - Type
         - Description
       * - rejectedCredentialOfferCid
         - `ContractId <https://docs.daml.com/daml/stdlib/Prelude.html#type-da-internal-lf-contractid-95282>`_ `RejectedCredentialOffer <type-utility-credential-app-v0-model-offer-rejectedcredentialoffer-74949_>`_
         - The rejected credential offer\.